# addToCart
Defined in: packages/shopify/api-client/src/api/addToCart/index.ts:7 (opens new window)
# Parameters:
Name | Type |
---|---|
__namedParameters | Cart |
product | ProductVariant |
quantity | number |
customQuery? | Record<string, string> |
Returns: Promise<CartResponse>
# createCart
Defined in: packages/shopify/api-client/src/api/createCart/index.ts:6 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
cartDraft | CartData |
customQuery? | Record<string, string> |
Returns: Promise<any>
# changePassword
Defined in: packages/shopify/api-client/src/api/changePassword/index.ts:4 (opens new window)
# Parameters:
Name | Type |
---|---|
__namedParameters | Object |
version | any |
currentPassword | string |
newPassword | string |
Returns: Promise<Graphmodel<Record<user, Customer>>>
# signIn
Defined in: packages/shopify/api-client/src/api/signIn/index.ts:5 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
draft | SignInDraft |
Returns: Promise<Graphmodel<Record<user, SignInResult>>>
# SignUp
Defined in: packages/shopify/api-client/src/api/signUp/index.ts:5 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
draft | SignUpDraft |
Returns: Promise<Graphmodel<Record<user, SignInResult>>>
# SignOut
Defined in: packages/shopify/api-client/src/api/SignOut/index.ts:1 (opens new window)
# Parameters:
Name | Type |
---|---|
__namedParameters | Object |
Returns: Promise<void>
# editProfile
Defined in: packages/shopify/api-client/src/api/editProfile/index.ts:4 (opens new window)
# Parameters:
Name | Type |
---|---|
__namedParameters | Object |
customerAccessToken | string |
customer | any |
# getCategory
Defined in: packages/shopify/api-client/src/api/getCategory/index.ts:12 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
params | any |
customQuery? | Record<string, string> |
Returns: Promise<Graphmodel<CategoryData>>
# fetchOrders
Defined in: packages/shopify/api-client/src/api/ferchOrders/index.ts:12 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
params | any |
customQuery? | Record<string, string> |
Returns: Promise<Graphmodel<OrdersData>>
# getProduct
Defined in: packages/shopify/api-client/src/api/getProduct/index.ts:12 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
params | any |
customQuery? | Record<string, string> |
Returns: Promise<Graphmodel<ProductData>>
# isGuest
Defined in: packages/shopify/api-client/src/api/isGuest/index.ts:3 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
Returns: any
# removeFromCart
Defined in: packages/shopify/api-client/src/api/removeFromCart/index.ts:7 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
cart | Cart |
product | LineItem |
customQuery? | Record<string, string> |
Returns: Promise<CartResponse>
# updateCart
Defined in: packages/shopify/api-client/src/api/updateCart/index.ts:15 (opens new window)
# Parameters:
Name | Type |
---|---|
context | any |
params | UpdateCartParams |
customQuery? | Record<string, string> |
Returns: any
# Type declaration:
Name | Type |
---|---|
activeCart ? | Maybe<Cart> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:55 (opens new window)
# AddAttributeDefinition
# Type declaration:
Name | Type |
---|---|
attributeDefinition | AttributeDefinitionDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:59 (opens new window)
# AddCartCustomLineItem
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
money | BaseMoneyInput |
name | LocalizedStringItemInputType[] |
quantity ? | Maybe<Scalars[Long]> |
shippingDetails ? | Maybe<ItemShippingDetailsDraft> |
slug | Scalars[String] |
taxCategory ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:63 (opens new window)
# AddCustomerAddress
# Type declaration:
Name | Type |
---|---|
address | AddressInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:113 (opens new window)
# AddCustomerBillingAddressId
# Type declaration:
Name | Type |
---|---|
addressId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:117 (opens new window)
# AddCustomerShippingAddressId
# Type declaration:
Name | Type |
---|---|
addressId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:121 (opens new window)
# AddMyCartLineItem
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
custom ? | Maybe<CustomFieldsDraft> |
distributionChannel ? | Maybe<ResourceIdentifierInput> |
productId ? | Maybe<Scalars[String]> |
quantity ? | Maybe<Scalars[Long]> |
shippingDetails ? | Maybe<ItemShippingDetailsDraft> |
sku ? | Maybe<Scalars[String]> |
supplyChannel ? | Maybe<ResourceIdentifierInput> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:138 (opens new window)
# AddOrderDelivery
# Type declaration:
Name | Type |
---|---|
address ? | Maybe<AddressInput> |
items ? | Maybe<DeliveryItemDraftType[]> |
parcels ? | Maybe<DeliveryItemDraftType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:150 (opens new window)
# AddOrderItemShippingAddress
# Type declaration:
Name | Type |
---|---|
address | AddressInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:156 (opens new window)
# AddOrderParcelToDelivery
# Type declaration:
Name | Type |
---|---|
deliveryId | Scalars[String] |
items ? | Maybe<DeliveryItemDraftType[]> |
measurements ? | Maybe<ParcelMeasurementsDraftType> |
trackingData ? | Maybe<TrackingDataDraftType> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:160 (opens new window)
# AddOrderPayment
# Type declaration:
Name | Type |
---|---|
payment | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:167 (opens new window)
# AddOrderReturnInfo
# Type declaration:
Name | Type |
---|---|
items | ReturnItemDraftType[] |
returnDate ? | Maybe<Scalars[DateTime]> |
returnTrackingId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:171 (opens new window)
# AddPlainEnumValue
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
value | PlainEnumValueDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:177 (opens new window)
# AddProductAsset
# Type declaration:
Name | Type |
---|---|
asset | AssetDraftInput |
catalog ? | Maybe<ReferenceInput> |
position ? | Maybe<Scalars[Int]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:182 (opens new window)
# AddProductExternalImage
# Type declaration:
Name | Type |
---|---|
image | ImageInput |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:191 (opens new window)
# AddProductPrice
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
price | ProductPriceDataInput |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:198 (opens new window)
# AddProductToCategory
# Type declaration:
Name | Type |
---|---|
category | ResourceIdentifierInput |
orderHint ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:206 (opens new window)
# AddProductVariant
# Type declaration:
Name | Type |
---|---|
assets ? | Maybe<AssetDraftInput[]> |
attributes ? | Maybe<ProductAttributeInput[]> |
images ? | Maybe<ImageInput[]> |
key ? | Maybe<Scalars[String]> |
prices ? | Maybe<ProductPriceDataInput[]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:212 (opens new window)
# AddShippingMethodShippingRate
# Type declaration:
Name | Type |
---|---|
shippingRate | ShippingRateDraft |
zone | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:289 (opens new window)
# AddShippingMethodZone
# Type declaration:
Name | Type |
---|---|
zone | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:294 (opens new window)
# AddShoppingListLineItem
# Type declaration:
Name | Type |
---|---|
addedAt ? | Maybe<Scalars[DateTime]> |
custom ? | Maybe<CustomFieldsDraft> |
productId ? | Maybe<Scalars[String]> |
quantity ? | Maybe<Scalars[Int]> |
sku ? | Maybe<Scalars[String]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:298 (opens new window)
# AddShoppingListTextLineItem
# Type declaration:
Name | Type |
---|---|
addedAt ? | Maybe<Scalars[DateTime]> |
custom ? | Maybe<CustomFieldsDraft> |
description ? | Maybe<LocalizedStringItemInputType[]> |
name | LocalizedStringItemInputType[] |
quantity ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:307 (opens new window)
# AddZoneLocation
# Type declaration:
Name | Type |
---|---|
location | ZoneLocation |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:315 (opens new window)
# Address
An address represents a postal address.
# Type declaration:
Name | Type |
---|---|
__typename ? | Address |
additionalAddressInfo ? | Maybe<Scalars[String]> |
additionalStreetInfo ? | Maybe<Scalars[String]> |
apartment ? | Maybe<Scalars[String]> |
building ? | Maybe<Scalars[String]> |
city ? | Maybe<Scalars[String]> |
company ? | Maybe<Scalars[String]> |
contactInfo | AddressContactInfo |
country | Scalars[Country] |
department ? | Maybe<Scalars[String]> |
email ? | Maybe<Scalars[String]> |
externalId ? | Maybe<Scalars[String]> |
fax ? | Maybe<Scalars[String]> |
firstName ? | Maybe<Scalars[String]> |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
lastName ? | Maybe<Scalars[String]> |
mobile ? | Maybe<Scalars[String]> |
pOBox ? | Maybe<Scalars[String]> |
phone ? | Maybe<Scalars[String]> |
postalCode ? | Maybe<Scalars[String]> |
region ? | Maybe<Scalars[String]> |
salutation ? | Maybe<Scalars[String]> |
state ? | Maybe<Scalars[String]> |
streetName ? | Maybe<Scalars[String]> |
streetNumber ? | Maybe<Scalars[String]> |
title ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:223 (opens new window)
# AddressContactInfo
# Type declaration:
Name | Type |
---|---|
__typename ? | AddressContactInfo |
email ? | Maybe<Scalars[String]> |
fax ? | Maybe<Scalars[String]> |
mobile ? | Maybe<Scalars[String]> |
phone ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:253 (opens new window)
# AddressInput
# Type declaration:
Name | Type |
---|---|
additionalAddressInfo ? | Maybe<Scalars[String]> |
additionalStreetInfo ? | Maybe<Scalars[String]> |
apartment ? | Maybe<Scalars[String]> |
building ? | Maybe<Scalars[String]> |
city ? | Maybe<Scalars[String]> |
company ? | Maybe<Scalars[String]> |
country | Scalars[Country] |
department ? | Maybe<Scalars[String]> |
email ? | Maybe<Scalars[String]> |
externalId ? | Maybe<Scalars[String]> |
fax ? | Maybe<Scalars[String]> |
firstName ? | Maybe<Scalars[String]> |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
lastName ? | Maybe<Scalars[String]> |
mobile ? | Maybe<Scalars[String]> |
pOBox ? | Maybe<Scalars[String]> |
phone ? | Maybe<Scalars[String]> |
postalCode ? | Maybe<Scalars[String]> |
region ? | Maybe<Scalars[String]> |
salutation ? | Maybe<Scalars[String]> |
state ? | Maybe<Scalars[String]> |
streetName ? | Maybe<Scalars[String]> |
streetNumber ? | Maybe<Scalars[String]> |
title ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:261 (opens new window)
# ApiClientWithSecret
API Clients can be used to obtain OAuth 2 access tokens. The secret is only shown once in the response of creating the API Client.
# Type declaration:
Name | Type |
---|---|
__typename ? | APIClientWithSecret |
createdAt ? | Maybe<Scalars[DateTime]> |
id | Scalars[String] |
lastUsedAt ? | Maybe<Scalars[Date]> |
name | Scalars[String] |
scope | Scalars[String] |
secret | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:358 (opens new window)
# ApiClientWithoutSecret
API Clients can be used to obtain OAuth 2 access tokens
# Type declaration:
Name | Type |
---|---|
__typename ? | APIClientWithoutSecret |
createdAt ? | Maybe<Scalars[DateTime]> |
id | Scalars[String] |
lastUsedAt ? | Maybe<Scalars[Date]> |
name | Scalars[String] |
scope | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:338 (opens new window)
# ApiClientWithoutSecretQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | APIClientWithoutSecretQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | ApiClientWithoutSecret[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:347 (opens new window)
# ApplyCartDeltaToCustomLineItemShippingDetailsTargets
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
targetsDelta | ShippingTargetDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:368 (opens new window)
# ApplyCartDeltaToLineItemShippingDetailsTargets
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
targetsDelta | ShippingTargetDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:373 (opens new window)
# Asset
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | Asset | - |
custom ? | Maybe<CustomFieldsType> | - |
customFieldList ? | Maybe<CustomField[]> | Custom fields are returned as a list instead of an object structure. |
customFields ? | Maybe<Type> | This field would contain type data |
customFieldsRaw ? | Maybe<RawCustomField[]> | This field contains non-typed data. Consider using customFields as a typed alternative. |
description ? | Maybe<Scalars[String]> | - |
descriptionAllLocales ? | Maybe<LocalizedString[]> | - |
id | Scalars[String] | - |
key ? | Maybe<Scalars[String]> | - |
name ? | Maybe<Scalars[String]> | - |
nameAllLocales | LocalizedString[] | - |
sources | AssetSource[] | - |
tags | Scalars[String][] | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:378 (opens new window)
# AssetCustomFieldListArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:412 (opens new window)
# AssetCustomFieldsRawArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:407 (opens new window)
# AssetDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:402 (opens new window)
# AssetDimensions
# Type declaration:
Name | Type |
---|---|
__typename ? | AssetDimensions |
height | Scalars[Int] |
width | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:417 (opens new window)
# AssetDimensionsInput
# Type declaration:
Name | Type |
---|---|
height | Scalars[Int] |
width | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:423 (opens new window)
# AssetDraftInput
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
description ? | Maybe<LocalizedStringItemInputType[]> |
key ? | Maybe<Scalars[String]> |
name | LocalizedStringItemInputType[] |
sources ? | Maybe<AssetSourceInput[]> |
tags ? | Maybe<Scalars[String][]> |
type ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:428 (opens new window)
# AssetNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:397 (opens new window)
# AssetSource
# Type declaration:
Name | Type |
---|---|
__typename ? | AssetSource |
contentType ? | Maybe<Scalars[String]> |
dimensions ? | Maybe<AssetDimensions> |
key ? | Maybe<Scalars[String]> |
uri | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:438 (opens new window)
# AssetSourceInput
# Type declaration:
Name | Type |
---|---|
contentType ? | Maybe<Scalars[String]> |
dimensions ? | Maybe<AssetDimensionsInput> |
key ? | Maybe<Scalars[String]> |
uri | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:446 (opens new window)
# Attribute
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:453 (opens new window)
# AttributeDefinition
# Type declaration:
Name | Type |
---|---|
__typename ? | AttributeDefinition |
attributeConstraint | AttributeConstraint |
inputHint | TextInputHint |
inputTip ? | Maybe<Scalars[String]> |
inputTipAllLocales ? | Maybe<LocalizedString[]> |
isRequired | Scalars[Boolean] |
isSearchable | Scalars[Boolean] |
label ? | Maybe<Scalars[String]> |
labelAllLocales | LocalizedString[] |
name | Scalars[String] |
type | AttributeDefinitionType |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:468 (opens new window)
# AttributeDefinitionDraft
# Type declaration:
Name | Type |
---|---|
attributeConstraint ? | Maybe<AttributeConstraint> |
inputHint ? | Maybe<TextInputHint> |
inputTip ? | Maybe<LocalizedStringItemInputType[]> |
isRequired | Scalars[Boolean] |
isSearchable | Scalars[Boolean] |
label | LocalizedStringItemInputType[] |
name | Scalars[String] |
type | AttributeTypeDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:492 (opens new window)
# AttributeDefinitionInputTipArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:487 (opens new window)
# AttributeDefinitionLabelArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:482 (opens new window)
# AttributeDefinitionResult
# Type declaration:
Name | Type |
---|---|
__typename ? | AttributeDefinitionResult |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
results | AttributeDefinition[] |
total | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:503 (opens new window)
# AttributeDefinitionType
(https://shopify.dev/api/storefront/reference/common-objects/attributeinput)[https://shopify.dev/api/storefront/reference/common-objects/attributeinput]
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:512 (opens new window)
# AttributeSetElementTypeDraft
# Type declaration:
Name | Type |
---|---|
boolean ? | Maybe<SimpleAttributeTypeDraft> |
date ? | Maybe<SimpleAttributeTypeDraft> |
datetime ? | Maybe<SimpleAttributeTypeDraft> |
enum ? | Maybe<EnumTypeDraft> |
lenum ? | Maybe<LocalizableEnumTypeDraft> |
ltext ? | Maybe<SimpleAttributeTypeDraft> |
money ? | Maybe<SimpleAttributeTypeDraft> |
number ? | Maybe<SimpleAttributeTypeDraft> |
reference ? | Maybe<ReferenceTypeDefinitionDraft> |
text ? | Maybe<SimpleAttributeTypeDraft> |
time ? | Maybe<SimpleAttributeTypeDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:516 (opens new window)
# AttributeSetTypeDraft
# Type declaration:
Name | Type |
---|---|
elementType | AttributeSetElementTypeDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:530 (opens new window)
# AttributeTypeDraft
# Type declaration:
Name | Type |
---|---|
boolean ? | Maybe<SimpleAttributeTypeDraft> |
date ? | Maybe<SimpleAttributeTypeDraft> |
datetime ? | Maybe<SimpleAttributeTypeDraft> |
enum ? | Maybe<EnumTypeDraft> |
lenum ? | Maybe<LocalizableEnumTypeDraft> |
ltext ? | Maybe<SimpleAttributeTypeDraft> |
money ? | Maybe<SimpleAttributeTypeDraft> |
number ? | Maybe<SimpleAttributeTypeDraft> |
reference ? | Maybe<ReferenceTypeDefinitionDraft> |
set ? | Maybe<AttributeSetTypeDraft> |
text ? | Maybe<SimpleAttributeTypeDraft> |
time ? | Maybe<SimpleAttributeTypeDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:534 (opens new window)
# BaseMoney
# Type declaration:
Name | Type |
---|---|
centAmount | Scalars[Long] |
currencyCode | Scalars[Currency] |
fractionDigits | Scalars[Int] |
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:549 (opens new window)
# BaseMoneyInput
# Type declaration:
Name | Type |
---|---|
centPrecision ? | Maybe<MoneyInput> |
highPrecision ? | Maybe<HighPrecisionMoneyInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:556 (opens new window)
# BaseSearchKeywordInput
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomSuggestTokenizerInput> |
whitespace ? | Maybe<WhitespaceSuggestTokenizerInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:561 (opens new window)
# BooleanAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:566 (opens new window)
# BooleanAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:572 (opens new window)
# BooleanField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:577 (opens new window)
# BooleanType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:583 (opens new window)
# Cart
A shopping cart holds product variants and can be ordered. Each cart either belongs to a registered customer or is an anonymous cart.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:591 (opens new window)
# CartClassificationInput
# Type declaration:
Name | Type |
---|---|
values | LocalizedEnumValueInput[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:654 (opens new window)
# CartClassificationType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:658 (opens new window)
# CartCustomFieldListArgs
A shopping cart holds product variants and can be ordered. Each cart either belongs to a registered customer or is an anonymous cart.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:649 (opens new window)
# CartCustomFieldsRawArgs
A shopping cart holds product variants and can be ordered. Each cart either belongs to a registered customer or is an anonymous cart.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:641 (opens new window)
# CartDiscount
Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:670 (opens new window)
# CartDiscountCustomFieldListArgs
Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:740 (opens new window)
# CartDiscountCustomFieldsRawArgs
Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:729 (opens new window)
# CartDiscountDescriptionArgs
Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:718 (opens new window)
# CartDiscountDraft
# Type declaration:
Name | Type |
---|---|
cartPredicate | Scalars[String] |
custom ? | Maybe<CustomFieldsDraft> |
description ? | Maybe<LocalizedStringItemInputType[]> |
isActive ? | Maybe<Scalars[Boolean]> |
key ? | Maybe<Scalars[String]> |
name | LocalizedStringItemInputType[] |
requiresDiscountCode ? | Maybe<Scalars[Boolean]> |
sortOrder | Scalars[String] |
stackingMode ? | Maybe<StackingMode> |
target ? | Maybe<CartDiscountTargetInput> |
validFrom ? | Maybe<Scalars[DateTime]> |
validUntil ? | Maybe<Scalars[DateTime]> |
value | CartDiscountValueInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:745 (opens new window)
# CartDiscountNameArgs
Cart discounts are recalculated every time LineItems or CustomLineItems are added or removed from the Cart or an order is created from the cart.
The number of active cart discounts that do not require a discount code (isActive=true and requiresDiscountCode=false) is limited to 100.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:707 (opens new window)
# CartDiscountQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | CartDiscountQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | CartDiscount[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:761 (opens new window)
# CartDiscountTarget
# Type declaration:
Name | Type |
---|---|
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:769 (opens new window)
# CartDiscountTargetInput
# Type declaration:
Name | Type |
---|---|
customLineItems ? | Maybe<CustomLineItemsTargetInput> |
lineItems ? | Maybe<LineItemsTargetInput> |
multiBuyCustomLineItems ? | Maybe<MultiBuyCustomLineItemsTargetInput> |
multiBuyLineItems ? | Maybe<MultiBuyLineItemsTargetInput> |
shipping ? | Maybe<ShippingTargetInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:773 (opens new window)
# CartDiscountUpdateAction
# Type declaration:
Name | Type |
---|---|
changeCartPredicate ? | Maybe<ChangeCartDiscountCartPredicate> |
changeIsActive ? | Maybe<ChangeCartDiscountIsActive> |
changeName ? | Maybe<ChangeCartDiscountName> |
changeRequiresDiscountCode ? | Maybe<ChangeCartDiscountRequiresDiscountCode> |
changeSortOrder ? | Maybe<ChangeCartDiscountSortOrder> |
changeStackingMode ? | Maybe<ChangeCartDiscountStackingMode> |
changeTarget ? | Maybe<ChangeCartDiscountTarget> |
changeValue ? | Maybe<ChangeCartDiscountValue> |
setCustomField ? | Maybe<SetCartDiscountCustomField> |
setCustomType ? | Maybe<SetCartDiscountCustomType> |
setDescription ? | Maybe<SetCartDiscountDescription> |
setKey ? | Maybe<SetCartDiscountKey> |
setValidFrom ? | Maybe<SetCartDiscountValidFrom> |
setValidFromAndUntil ? | Maybe<SetCartDiscountValidFromAndUntil> |
setValidUntil ? | Maybe<SetCartDiscountValidUntil> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:781 (opens new window)
# CartDiscountValue
# Type declaration:
Name | Type |
---|---|
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:799 (opens new window)
# CartDiscountValueInput
# Type declaration:
Name | Type |
---|---|
absolute ? | Maybe<AbsoluteDiscountValueInput> |
giftLineItem ? | Maybe<GiftLineItemValueInput> |
relative ? | Maybe<RelativeDiscountValueInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:803 (opens new window)
# CartDraft
# Type declaration:
Name | Type |
---|---|
anonymousId ? | Maybe<Scalars[String]> |
billingAddress ? | Maybe<AddressInput> |
country ? | Maybe<Scalars[Country]> |
currency | Scalars[Currency] |
custom ? | Maybe<CustomFieldsDraft> |
customLineItems ? | Maybe<CustomLineItemDraft[]> |
customerEmail ? | Maybe<Scalars[String]> |
customerGroup ? | Maybe<ResourceIdentifierInput> |
customerId ? | Maybe<Scalars[String]> |
deleteDaysAfterLastModification ? | Maybe<Scalars[Int]> |
discountCodes ? | Maybe<Scalars[String][]> |
externalTaxRateForShippingMethod ? | Maybe<ExternalTaxRateDraft> |
inventoryMode ? | Maybe<InventoryMode> |
itemShippingAddresses ? | Maybe<AddressInput[]> |
lineItems ? | Maybe<LineItemDraft[]> |
locale ? | Maybe<Scalars[Locale]> |
origin ? | Maybe<CartOrigin> |
shippingAddress ? | Maybe<AddressInput> |
shippingMethod ? | Maybe<ResourceIdentifierInput> |
shippingRateInput ? | Maybe<ShippingRateInputDraft> |
store ? | Maybe<ResourceIdentifierInput> |
taxCalculationMode ? | Maybe<TaxCalculationMode> |
taxMode ? | Maybe<TaxMode> |
taxRoundingMode ? | Maybe<RoundingMode> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:809 (opens new window)
# CartQueryInterface
Fields to access carts. Includes direct access to a single cart and searching for carts.
# Type declaration:
Name | Type |
---|---|
cart ? | Maybe<Cart> |
carts | CartQueryResult |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:844 (opens new window)
# CartQueryInterfaceCartArgs
Fields to access carts. Includes direct access to a single cart and searching for carts.
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:850 (opens new window)
# CartQueryInterfaceCartsArgs
Fields to access carts. Includes direct access to a single cart and searching for carts.
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:855 (opens new window)
# CartQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | CartQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Cart[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:862 (opens new window)
# CartScoreInput
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:870 (opens new window)
# CartScoreType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:874 (opens new window)
# CartUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:888 (opens new window)
# CartValueInput
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:949 (opens new window)
# CartValueType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:953 (opens new window)
# Category
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:958 (opens new window)
# CategoryCustomFieldListArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1035 (opens new window)
# CategoryCustomFieldsRawArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1030 (opens new window)
# CategoryDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1005 (opens new window)
# CategoryDraft
# Type declaration:
Name | Type |
---|---|
assets ? | Maybe<AssetDraftInput[]> |
custom ? | Maybe<CustomFieldsDraft> |
description ? | Maybe<LocalizedStringItemInputType[]> |
externalId ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
metaDescription ? | Maybe<LocalizedStringItemInputType[]> |
metaKeywords ? | Maybe<LocalizedStringItemInputType[]> |
metaTitle ? | Maybe<LocalizedStringItemInputType[]> |
name | LocalizedStringItemInputType[] |
orderHint ? | Maybe<Scalars[String]> |
parent ? | Maybe<ResourceIdentifierInput> |
slug | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1040 (opens new window)
# CategoryMetaDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1025 (opens new window)
# CategoryMetaKeywordsArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1020 (opens new window)
# CategoryMetaTitleArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1015 (opens new window)
# CategoryNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1000 (opens new window)
# CategoryOrderHint
# Type declaration:
Name | Type |
---|---|
__typename ? | CategoryOrderHint |
categoryId | Scalars[String] |
orderHint | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1055 (opens new window)
# CategoryOrderHintInput
# Type declaration:
Name | Type |
---|---|
orderHint | Scalars[String] |
uuid | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1061 (opens new window)
# CategoryQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | CategoryQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Category[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1066 (opens new window)
# CategorySearch
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | CategorySearch | - |
ancestors | CategorySearch[] | - |
ancestorsRef | Reference[] | - |
assets | Asset[] | - |
childCount | Scalars[Int] | - |
children | CategorySearch[] | Direct child categories. |
createdAt | Scalars[DateTime] | - |
custom ? | Maybe<CustomFieldsType> | - |
customFieldList ? | Maybe<CustomField[]> | Custom fields are returned as a list instead of an object structure. |
customFields ? | Maybe<Type> | This field would contain type data |
customFieldsRaw ? | Maybe<RawCustomField[]> | This field contains non-typed data. Consider using customFields as a typed alternative. |
description ? | Maybe<Scalars[String]> | - |
descriptionAllLocales ? | Maybe<LocalizedString[]> | - |
externalId ? | Maybe<Scalars[String]> | - |
id | Scalars[String] | - |
key ? | Maybe<Scalars[String]> | - |
lastModifiedAt | Scalars[DateTime] | - |
name ? | Maybe<Scalars[String]> | - |
nameAllLocales | LocalizedString[] | - |
orderHint | Scalars[String] | - |
parent ? | Maybe<CategorySearch> | - |
parentRef ? | Maybe<Reference> | - |
productCount | Scalars[Int] | - |
productTypeNames | Scalars[String][] | - |
slug ? | Maybe<Scalars[String]> | - |
slugAllLocales | LocalizedString[] | - |
stagedProductCount | Scalars[Int] | - |
version | Scalars[Long] | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1074 (opens new window)
# CategorySearchCustomFieldListArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1129 (opens new window)
# CategorySearchCustomFieldsRawArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1124 (opens new window)
# CategorySearchDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1114 (opens new window)
# CategorySearchNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1109 (opens new window)
# CategorySearchResult
# Type declaration:
Name | Type |
---|---|
__typename ? | CategorySearchResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | CategorySearch[] |
total | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1134 (opens new window)
# CategorySearchSlugArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1119 (opens new window)
# CategorySlugArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1010 (opens new window)
# CategoryUpdateAction
# Type declaration:
Name | Type |
---|---|
addAsset ? | Maybe<AddCategoryAsset> |
changeAssetName ? | Maybe<ChangeCategoryAssetName> |
changeAssetOrder ? | Maybe<ChangeCategoryAssetOrder> |
changeName ? | Maybe<ChangeCategoryName> |
changeOrderHint ? | Maybe<ChangeCategoryOrderHint> |
changeParent ? | Maybe<ChangeCategoryParent> |
changeSlug ? | Maybe<ChangeCategorySlug> |
removeAsset ? | Maybe<RemoveCategoryAsset> |
setAssetCustomField ? | Maybe<SetCategoryAssetCustomField> |
setAssetCustomType ? | Maybe<SetCategoryAssetCustomType> |
setAssetDescription ? | Maybe<SetCategoryAssetDescription> |
setAssetKey ? | Maybe<SetCategoryAssetKey> |
setAssetSources ? | Maybe<SetCategoryAssetSources> |
setAssetTags ? | Maybe<SetCategoryAssetTags> |
setCustomField ? | Maybe<SetCategoryCustomField> |
setCustomType ? | Maybe<SetCategoryCustomType> |
setDescription ? | Maybe<SetCategoryDescription> |
setExternalId ? | Maybe<SetCategoryExternalId> |
setKey ? | Maybe<SetCategoryKey> |
setMetaDescription ? | Maybe<SetCategoryMetaDescription> |
setMetaKeywords ? | Maybe<SetCategoryMetaKeywords> |
setMetaTitle ? | Maybe<SetCategoryMetaTitle> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1142 (opens new window)
# ChangeAttributeName
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
newAttributeName | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1167 (opens new window)
# ChangeAttributeOrder
# Type declaration:
Name | Type |
---|---|
attributeDefinitions | AttributeDefinitionDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1172 (opens new window)
# ChangeAttributeOrderByName
# Type declaration:
Name | Type |
---|---|
attributeNames | Scalars[String][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1176 (opens new window)
# ChangeCartCustomLineItemMoney
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
money | BaseMoneyInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1180 (opens new window)
# ChangeCartCustomLineItemQuantity
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1185 (opens new window)
# ChangeCartDiscountCartPredicate
# Type declaration:
Name | Type |
---|---|
cartPredicate | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1190 (opens new window)
# ChangeCartDiscountIsActive
# Type declaration:
Name | Type |
---|---|
isActive | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1194 (opens new window)
# ChangeCartDiscountName
# Type declaration:
Name | Type |
---|---|
name | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1198 (opens new window)
# ChangeCartDiscountRequiresDiscountCode
# Type declaration:
Name | Type |
---|---|
requiresDiscountCode | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1202 (opens new window)
# ChangeCartDiscountSortOrder
# Type declaration:
Name | Type |
---|---|
sortOrder | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1206 (opens new window)
# ChangeCartDiscountStackingMode
# Type declaration:
Name | Type |
---|---|
stackingMode | StackingMode |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1210 (opens new window)
# ChangeCartDiscountTarget
# Type declaration:
Name | Type |
---|---|
target | CartDiscountTargetInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1214 (opens new window)
# ChangeCartDiscountValue
# Type declaration:
Name | Type |
---|---|
value | CartDiscountValueInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1218 (opens new window)
# ChangeCartLineItemQuantity
# Type declaration:
Name | Type |
---|---|
externalPrice ? | Maybe<BaseMoneyInput> |
externalTotalPrice ? | Maybe<ExternalLineItemTotalPriceDraft> |
lineItemId | Scalars[String] |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1222 (opens new window)
# ChangeCartTaxCalculationMode
# Type declaration:
Name | Type |
---|---|
taxCalculationMode | TaxCalculationMode |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1229 (opens new window)
# ChangeCartTaxMode
# Type declaration:
Name | Type |
---|---|
taxMode | TaxMode |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1233 (opens new window)
# ChangeCartTaxRoundingMode
# Type declaration:
Name | Type |
---|---|
taxRoundingMode | RoundingMode |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1237 (opens new window)
# ChangeCategoryAssetName
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
name | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1241 (opens new window)
# ChangeCategoryAssetOrder
# Type declaration:
Name | Type |
---|---|
assetOrder | Scalars[String][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1247 (opens new window)
# ChangeCategoryName
# Type declaration:
Name | Type |
---|---|
name | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1251 (opens new window)
# ChangeCategoryOrderHint
# Type declaration:
Name | Type |
---|---|
orderHint | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1255 (opens new window)
# ChangeCategoryParent
# Type declaration:
Name | Type |
---|---|
parent | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1259 (opens new window)
# ChangeCategorySlug
# Type declaration:
Name | Type |
---|---|
slug | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1263 (opens new window)
# ChangeCustomerAddress
# Type declaration:
Name | Type |
---|---|
address | AddressInput |
addressId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1267 (opens new window)
# ChangeCustomerEmail
# Type declaration:
Name | Type |
---|---|
email | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1272 (opens new window)
# ChangeCustomerGroupName
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1276 (opens new window)
# ChangeDescription
# Type declaration:
Name | Type |
---|---|
description | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1280 (opens new window)
# ChangeDiscountCodeCartDiscounts
# Type declaration:
Name | Type |
---|---|
cartDiscounts | ReferenceInput[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1284 (opens new window)
# ChangeDiscountCodeGroups
# Type declaration:
Name | Type |
---|---|
groups | Scalars[String][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1288 (opens new window)
# ChangeDiscountCodeIsActive
# Type declaration:
Name | Type |
---|---|
isActive | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1292 (opens new window)
# ChangeEnumKey
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
key | Scalars[String] |
newKey | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1296 (opens new window)
# ChangeInputHint
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
newValue | TextInputHint |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1302 (opens new window)
# ChangeInventoryEntryQuantity
# Type declaration:
Name | Type |
---|---|
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1307 (opens new window)
# ChangeIsSearchable
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
isSearchable | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1311 (opens new window)
# ChangeLabel
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
label | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1316 (opens new window)
# ChangeLocalizedEnumValueLabel
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
newValue | LocalizedEnumValueDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1321 (opens new window)
# ChangeLocalizedEnumValueOrder
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
values | LocalizedEnumValueDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1326 (opens new window)
# ChangeMyCartTaxMode
# Type declaration:
Name | Type |
---|---|
taxMode | TaxMode |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1331 (opens new window)
# ChangeName
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1335 (opens new window)
# ChangeOrderPaymentState
# Type declaration:
Name | Type |
---|---|
paymentState | PaymentState |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1339 (opens new window)
# ChangeOrderShipmentState
# Type declaration:
Name | Type |
---|---|
shipmentState | ShipmentState |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1343 (opens new window)
# ChangeOrderState
# Type declaration:
Name | Type |
---|---|
orderState | OrderState |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1347 (opens new window)
# ChangePlainEnumValueLabel
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
newValue | PlainEnumValueDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1351 (opens new window)
# ChangePlainEnumValueOrder
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
values | PlainEnumValueDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1356 (opens new window)
# ChangeProductAssetName
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
name | LocalizedStringItemInputType[] |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1361 (opens new window)
# ChangeProductAssetOrder
# Type declaration:
Name | Type |
---|---|
assetOrder | Scalars[String][] |
catalog ? | Maybe<ReferenceInput> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1371 (opens new window)
# ChangeProductDiscountIsActive
# Type declaration:
Name | Type |
---|---|
isActive | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1379 (opens new window)
# ChangeProductDiscountName
# Type declaration:
Name | Type |
---|---|
name | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1383 (opens new window)
# ChangeProductDiscountPredicate
# Type declaration:
Name | Type |
---|---|
predicate | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1387 (opens new window)
# ChangeProductDiscountSortOrder
# Type declaration:
Name | Type |
---|---|
sortOrder | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1391 (opens new window)
# ChangeProductDiscountValue
# Type declaration:
Name | Type |
---|---|
value | ProductDiscountValueInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1395 (opens new window)
# ChangeProductImageLabel
# Type declaration:
Name | Type |
---|---|
imageUrl | Scalars[String] |
label ? | Maybe<Scalars[String]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1399 (opens new window)
# ChangeProductMasterVariant
# Type declaration:
Name | Type |
---|---|
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1407 (opens new window)
# ChangeProductName
# Type declaration:
Name | Type |
---|---|
name | LocalizedStringItemInputType[] |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1413 (opens new window)
# ChangeProductPrice
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
price | ProductPriceDataInput |
priceId ? | Maybe<Scalars[String]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1418 (opens new window)
# ChangeProductSlug
# Type declaration:
Name | Type |
---|---|
slug | LocalizedStringItemInputType[] |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1427 (opens new window)
# ChangeProjectSettingsCountries
# Type declaration:
Name | Type |
---|---|
countries | Scalars[Country][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1432 (opens new window)
# ChangeProjectSettingsCurrencies
# Type declaration:
Name | Type |
---|---|
currencies | Scalars[Currency][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1436 (opens new window)
# ChangeProjectSettingsLanguages
# Type declaration:
Name | Type |
---|---|
languages | Scalars[Locale][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1440 (opens new window)
# ChangeProjectSettingsMessagesConfiguration
# Type declaration:
Name | Type |
---|---|
messagesConfiguration | MessagesConfigurationDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1444 (opens new window)
# ChangeProjectSettingsMessagesEnabled
# Type declaration:
Name | Type |
---|---|
messagesEnabled | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1448 (opens new window)
# ChangeProjectSettingsName
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1452 (opens new window)
# ChangeShippingMethodIsDefault
# Type declaration:
Name | Type |
---|---|
isDefault | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1456 (opens new window)
# ChangeShippingMethodName
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1460 (opens new window)
# ChangeShippingMethodTaxCategory
# Type declaration:
Name | Type |
---|---|
taxCategory | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1464 (opens new window)
# ChangeShoppingListLineItemQuantity
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
quantity | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1468 (opens new window)
# ChangeShoppingListLineItemsOrder
# Type declaration:
Name | Type |
---|---|
lineItemOrder | Scalars[String][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1473 (opens new window)
# ChangeShoppingListName
# Type declaration:
Name | Type |
---|---|
name | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1477 (opens new window)
# ChangeShoppingListTextLineItemName
# Type declaration:
Name | Type |
---|---|
name | LocalizedStringItemInputType[] |
textLineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1481 (opens new window)
# ChangeShoppingListTextLineItemQuantity
# Type declaration:
Name | Type |
---|---|
quantity | Scalars[Int] |
textLineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1486 (opens new window)
# ChangeShoppingListTextLineItemsOrder
# Type declaration:
Name | Type |
---|---|
textLineItemOrder | Scalars[String][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1491 (opens new window)
# ChangeZoneName
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1495 (opens new window)
# Channel
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1499 (opens new window)
# ChannelCustomFieldsRawArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1532 (opens new window)
# ChannelDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1527 (opens new window)
# ChannelNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1522 (opens new window)
# ChannelQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | ChannelQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Channel[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1537 (opens new window)
# ChannelReferenceIdentifier
# Type declaration:
Name | Type |
---|---|
__typename ? | ChannelReferenceIdentifier |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
typeId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1545 (opens new window)
# ClassificationShippingRateInput
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1570 (opens new window)
# ClassificationShippingRateInputDraft
# Type declaration:
Name | Type |
---|---|
key | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1583 (opens new window)
# ClassificationShippingRateInputLabelArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1578 (opens new window)
# CreateApiClient
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
scope | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1587 (opens new window)
# CreateStore
# Type declaration:
Name | Type |
---|---|
key | Scalars[String] |
languages ? | Maybe<Scalars[Locale][]> |
name ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1592 (opens new window)
# CreateZone
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
locations ? | Maybe<ZoneLocation[]> |
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1598 (opens new window)
# CustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1901 (opens new window)
# CustomFieldInput
A key-value pair representing the field name and value of one single custom field.
The value of this custom field consists of escaped JSON based on the FieldDefinition of the Type.
Examples for value
:
- FieldType
String
:"\"This is a string\""
- FieldType
DateTimeType
:"\"2001-09-11T14:00:00.000Z\""
- FieldType
Number
:"4"
- FieldType
Set
with an elementType ofString
:"[\"This is a string\", \"This is another string\"]"
- FieldType
Reference
:"{\"id\", \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\", \"product\"}"
# Type declaration:
Name | Type | Description |
---|---|---|
name | Scalars[String] | - |
value | Scalars[String] | The value of this custom field consists of escaped JSON based on the FieldDefinition of the Type. Examples for value : * FieldType String : "\"This is a string\"" * FieldType DateTimeType : "\"2001-09-11T14:00:00.000Z\"" * FieldType Number : "4" * FieldType Set with an elementType of String : "[\"This is a string\", \"This is another string\"]" * FieldType Reference : "{\"id\", \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\", \"product\"}" |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1917 (opens new window)
# CustomFieldsDraft
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1932 (opens new window)
# CustomFieldsType
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | CustomFieldsType | - |
customFieldList ? | Maybe<CustomField[]> | Custom fields are returned as a list instead of an object structure. |
customFields | Type | This field would contain type data |
customFieldsRaw ? | Maybe<RawCustomField[]> | This field contains non-typed data. For a typed alternative, have a look at customFields . |
type ? | Maybe<TypeDefinition> | - |
typeRef | Reference | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1939 (opens new window)
# CustomFieldsTypeCustomFieldListArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1956 (opens new window)
# CustomFieldsTypeCustomFieldsRawArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1951 (opens new window)
# CustomLineItem
A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item.
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | CustomLineItem | - |
custom ? | Maybe<CustomFieldsType> | - |
customFieldList ? | Maybe<CustomField[]> | Custom fields are returned as a list instead of an object structure. |
customFields ? | Maybe<Type> | This field would contain type data |
customFieldsRaw ? | Maybe<RawCustomField[]> | This field contains non-typed data. Consider using customFields as a typed alternative. |
discountedPricePerQuantity | DiscountedLineItemPriceForQuantity[] | - |
id | Scalars[String] | - |
money | BaseMoney | - |
name ? | Maybe<Scalars[String]> | - |
nameAllLocales | LocalizedString[] | - |
quantity | Scalars[Long] | - |
shippingDetails ? | Maybe<ItemShippingDetails> | - |
slug | Scalars[String] | - |
state | ItemState[] | - |
taxCategory ? | Maybe<TaxCategory> | - |
taxCategoryRef ? | Maybe<Reference> | - |
taxRate ? | Maybe<TaxRate> | - |
totalPrice | Money | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1965 (opens new window)
# CustomLineItemCustomFieldListArgs
A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2011 (opens new window)
# CustomLineItemCustomFieldsRawArgs
A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2002 (opens new window)
# CustomLineItemDraft
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
money | BaseMoneyInput |
name | LocalizedStringItemInputType[] |
quantity ? | Maybe<Scalars[Long]> |
shippingDetails ? | Maybe<ItemShippingDetailsDraft> |
slug | Scalars[String] |
taxCategory ? | Maybe<ReferenceInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2016 (opens new window)
# CustomLineItemNameArgs
A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1993 (opens new window)
# CustomLineItemReturnItem
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2027 (opens new window)
# CustomLineItemsTarget
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2040 (opens new window)
# CustomLineItemsTargetInput
# Type declaration:
Name | Type |
---|---|
predicate | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2046 (opens new window)
# CustomSuggestTokenizerInput
# Type declaration:
Name | Type |
---|---|
suggestTokenizer ? | Maybe<BaseSearchKeywordInput> |
text | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2050 (opens new window)
# Customer
A customer is a person purchasing products. Carts, Orders and Reviews can be associated to a customer.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1606 (opens new window)
# CustomerActiveCartInterface
A field to access a customer's active cart.
# Type declaration:
Name | Type |
---|---|
customerActiveCart ? | Maybe<Cart> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1664 (opens new window)
# CustomerActiveCartInterfaceCustomerActiveCartArgs
A field to access a customer's active cart.
# Type declaration:
Name | Type |
---|---|
customerId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1669 (opens new window)
# CustomerCustomFieldListArgs
A customer is a person purchasing products. Carts, Orders and Reviews can be associated to a customer.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1658 (opens new window)
# CustomerCustomFieldsRawArgs
A customer is a person purchasing products. Carts, Orders and Reviews can be associated to a customer.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1652 (opens new window)
# CustomerGroup
A customer can be a member in a customer group (e.g. reseller, gold member). A customer group can be used in price calculations with special prices being assigned to certain customer groups.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1677 (opens new window)
# CustomerGroupCustomFieldListArgs
A customer can be a member in a customer group (e.g. reseller, gold member). A customer group can be used in price calculations with special prices being assigned to certain customer groups.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1709 (opens new window)
# CustomerGroupCustomFieldsRawArgs
A customer can be a member in a customer group (e.g. reseller, gold member). A customer group can be used in price calculations with special prices being assigned to certain customer groups.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1700 (opens new window)
# CustomerGroupDraft
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
groupName | Scalars[String] |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1714 (opens new window)
# CustomerGroupQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | CustomerGroupQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | CustomerGroup[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1720 (opens new window)
# CustomerGroupUpdateAction
# Type declaration:
Name | Type |
---|---|
changeName ? | Maybe<ChangeCustomerGroupName> |
setCustomField ? | Maybe<SetCustomerGroupCustomField> |
setCustomType ? | Maybe<SetCustomerGroupCustomType> |
setKey ? | Maybe<SetCustomerGroupKey> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1728 (opens new window)
# CustomerQueryInterface
Fields to access customer accounts. Includes direct access to a single customer and searching for customers.
# Type declaration:
Name | Type |
---|---|
customer ? | Maybe<Customer> |
customers | CustomerQueryResult |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1736 (opens new window)
# CustomerQueryInterfaceCustomerArgs
Fields to access customer accounts. Includes direct access to a single customer and searching for customers.
# Type declaration:
Name | Type |
---|---|
emailToken ? | Maybe<Scalars[String]> |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
passwordToken ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1742 (opens new window)
# CustomerQueryInterfaceCustomersArgs
Fields to access customer accounts. Includes direct access to a single customer and searching for customers.
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1750 (opens new window)
# CustomerQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | CustomerQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Customer[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1757 (opens new window)
# CustomerSignInDraft
# Type declaration:
Name | Type |
---|---|
anonymousCartId ? | Maybe<Scalars[String]> |
anonymousCartSignInMode ? | Maybe<AnonymousCartSignInMode> |
anonymousId ? | Maybe<Scalars[String]> |
email | Scalars[String] |
password | Scalars[String] |
updateProductData ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1765 (opens new window)
# CustomerSignInResult
# Type declaration:
Name | Type |
---|---|
__typename ? | CustomerSignInResult |
cart ? | Maybe<Cart> |
customer | Customer |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1774 (opens new window)
# CustomerSignMeInDraft
# Type declaration:
Name | Type |
---|---|
activeCartSignInMode ? | Maybe<AnonymousCartSignInMode> |
email | Scalars[String] |
password | Scalars[String] |
updateProductData ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1780 (opens new window)
# CustomerSignMeUpDraft
# Type declaration:
Name | Type | Description |
---|---|---|
addresses ? | Maybe<AddressInput[]> | - |
billingAddresses ? | Maybe<Scalars[Int][]> | The indices of the billing addresses in the addresses list. The billingAddressIds of the customer will be set to the IDs of that addresses. |
companyName ? | Maybe<Scalars[String]> | - |
custom ? | Maybe<CustomFieldsDraft> | - |
dateOfBirth ? | Maybe<Scalars[Date]> | - |
defaultBillingAddress ? | Maybe<Scalars[Int]> | The index of the address in the addresses list. The defaultBillingAddressId of the customer will be set to the ID of that address. |
defaultShippingAddress ? | Maybe<Scalars[Int]> | The index of the address in the addresses list. The defaultShippingAddressId of the customer will be set to the ID of that address. |
email | Scalars[String] | - |
firstName ? | Maybe<Scalars[String]> | - |
key ? | Maybe<Scalars[String]> | - |
lastName ? | Maybe<Scalars[String]> | - |
locale ? | Maybe<Scalars[Locale]> | - |
middleName ? | Maybe<Scalars[String]> | - |
password | Scalars[String] | - |
salutation ? | Maybe<Scalars[String]> | - |
shippingAddresses ? | Maybe<Scalars[Int][]> | The indices of the shipping addresses in the addresses list. The shippingAddressIds of the Customer will be set to the IDs of that addresses. |
stores ? | Maybe<ResourceIdentifierInput[]> | - |
title ? | Maybe<Scalars[String]> | - |
vatId ? | Maybe<Scalars[String]> | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1787 (opens new window)
# CustomerSignUpDraft
# Type declaration:
Name | Type | Description |
---|---|---|
addresses ? | Maybe<AddressInput[]> | - |
anonymousCartId ? | Maybe<Scalars[String]> | - |
anonymousId ? | Maybe<Scalars[String]> | - |
billingAddresses ? | Maybe<Scalars[Int][]> | The indices of the billing addresses in the addresses list. The billingAddressIds of the customer will be set to the IDs of that addresses. |
companyName ? | Maybe<Scalars[String]> | - |
custom ? | Maybe<CustomFieldsDraft> | - |
customerGroup ? | Maybe<ResourceIdentifierInput> | - |
customerNumber ? | Maybe<Scalars[String]> | - |
dateOfBirth ? | Maybe<Scalars[Date]> | - |
defaultBillingAddress ? | Maybe<Scalars[Int]> | The index of the address in the addresses list. The defaultBillingAddressId of the customer will be set to the ID of that address. |
defaultShippingAddress ? | Maybe<Scalars[Int]> | The index of the address in the addresses list. The defaultShippingAddressId of the customer will be set to the ID of that address. |
email | Scalars[String] | - |
externalId ? | Maybe<Scalars[String]> | - |
firstName ? | Maybe<Scalars[String]> | - |
isEmailVerified ? | Maybe<Scalars[Boolean]> | - |
key ? | Maybe<Scalars[String]> | - |
lastName ? | Maybe<Scalars[String]> | - |
locale ? | Maybe<Scalars[Locale]> | - |
middleName ? | Maybe<Scalars[String]> | - |
password | Scalars[String] | - |
salutation ? | Maybe<Scalars[String]> | - |
shippingAddresses ? | Maybe<Scalars[Int][]> | The indices of the shipping addresses in the addresses list. The shippingAddressIds of the Customer will be set to the IDs of that addresses. |
stores ? | Maybe<ResourceIdentifierInput[]> | - |
title ? | Maybe<Scalars[String]> | - |
vatId ? | Maybe<Scalars[String]> | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1821 (opens new window)
# CustomerToken
# Type declaration:
Name | Type |
---|---|
__typename ? | CustomerToken |
createdAt | Scalars[DateTime] |
customerId | Scalars[String] |
expiresAt | Scalars[DateTime] |
id | Scalars[String] |
value | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1861 (opens new window)
# CustomerUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:1870 (opens new window)
# DateAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2055 (opens new window)
# DateAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2061 (opens new window)
# DateField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2066 (opens new window)
# DateTimeAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2072 (opens new window)
# DateTimeAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2078 (opens new window)
# DateTimeField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2083 (opens new window)
# DateTimeType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2089 (opens new window)
# DateType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2094 (opens new window)
# Delivery
# Type declaration:
Name | Type |
---|---|
__typename ? | Delivery |
address ? | Maybe<Address> |
createdAt | Scalars[DateTime] |
id | Scalars[String] |
items | DeliveryItem[] |
parcels | Parcel[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2099 (opens new window)
# DeliveryItem
# Type declaration:
Name | Type |
---|---|
__typename ? | DeliveryItem |
id | Scalars[String] |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2108 (opens new window)
# DeliveryItemDraftType
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2114 (opens new window)
# Dimensions
# Type declaration:
Name | Type |
---|---|
__typename ? | Dimensions |
height | Scalars[Int] |
width | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2119 (opens new window)
# DimensionsInput
# Type declaration:
Name | Type |
---|---|
height | Scalars[Int] |
width | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2125 (opens new window)
# DiscountCode
With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2134 (opens new window)
# DiscountCodeCustomFieldListArgs
With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2199 (opens new window)
# DiscountCodeCustomFieldsRawArgs
With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2190 (opens new window)
# DiscountCodeDescriptionArgs
With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2181 (opens new window)
# DiscountCodeDraft
# Type declaration:
Name | Type |
---|---|
cartDiscounts | ReferenceInput[] |
cartPredicate ? | Maybe<Scalars[String]> |
code | Scalars[String] |
custom ? | Maybe<CustomFieldsDraft> |
description ? | Maybe<LocalizedStringItemInputType[]> |
groups ? | Maybe<Scalars[String][]> |
isActive ? | Maybe<Scalars[Boolean]> |
maxApplications ? | Maybe<Scalars[Long]> |
maxApplicationsPerCustomer ? | Maybe<Scalars[Long]> |
name ? | Maybe<LocalizedStringItemInputType[]> |
validFrom ? | Maybe<Scalars[DateTime]> |
validUntil ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2204 (opens new window)
# DiscountCodeInfo
# Type declaration:
Name | Type |
---|---|
__typename ? | DiscountCodeInfo |
discountCode ? | Maybe<DiscountCode> |
discountCodeRef | Reference |
state ? | Maybe<DiscountCodeState> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2219 (opens new window)
# DiscountCodeNameArgs
With discount codes it is possible to give specific cart discounts to an eligible amount of users. They are defined by a string value which can be added to a cart so that specific cart discounts can be applied to the cart.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2172 (opens new window)
# DiscountCodeQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | DiscountCodeQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | DiscountCode[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2226 (opens new window)
# DiscountCodeUpdateAction
# Type declaration:
Name | Type |
---|---|
changeCartDiscounts ? | Maybe<ChangeDiscountCodeCartDiscounts> |
changeGroups ? | Maybe<ChangeDiscountCodeGroups> |
changeIsActive ? | Maybe<ChangeDiscountCodeIsActive> |
setCartPredicate ? | Maybe<SetDiscountCodeCartPredicate> |
setCustomField ? | Maybe<SetDiscountCodeCustomField> |
setCustomType ? | Maybe<SetDiscountCodeCustomType> |
setDescription ? | Maybe<SetDiscountCodeDescription> |
setMaxApplications ? | Maybe<SetDiscountCodeMaxApplications> |
setMaxApplicationsPerCustomer ? | Maybe<SetDiscountCodeMaxApplicationsPerCustomer> |
setName ? | Maybe<SetDiscountCodeName> |
setValidFrom ? | Maybe<SetDiscountCodeValidFrom> |
setValidFromAndUntil ? | Maybe<SetDiscountCodeValidFromAndUntil> |
setValidUntil ? | Maybe<SetDiscountCodeValidUntil> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2260 (opens new window)
# DiscountedLineItemPortion
# Type declaration:
Name | Type |
---|---|
__typename ? | DiscountedLineItemPortion |
discount ? | Maybe<CartDiscount> |
discountRef | Reference |
discountedAmount | BaseMoney |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2278 (opens new window)
# DiscountedLineItemPrice
# Type declaration:
Name | Type |
---|---|
__typename ? | DiscountedLineItemPrice |
includedDiscounts | DiscountedLineItemPortion[] |
value | BaseMoney |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2285 (opens new window)
# DiscountedLineItemPriceForQuantity
# Type declaration:
Name | Type |
---|---|
__typename ? | DiscountedLineItemPriceForQuantity |
discountedPrice | DiscountedLineItemPrice |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2291 (opens new window)
# DiscountedProductPriceValue
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | DiscountedProductPriceValue | - |
discount ? | Maybe<ProductDiscount> | - |
discountRef | Reference | - |
discountRel ? | Maybe<ProductDiscount> | Temporal. Will be renamed some time in the future. Please use 'discount'. |
value | BaseMoney | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2297 (opens new window)
# DiscountedProductPriceValueInput
# Type declaration:
Name | Type |
---|---|
discount | ReferenceInput |
value | BaseMoneyInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2306 (opens new window)
# EnumAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2311 (opens new window)
# EnumAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2318 (opens new window)
# EnumAttributeDefinitionTypeValuesArgs
# Type declaration:
Name | Type |
---|---|
excludeKeys ? | Maybe<Scalars[String][]> |
includeKeys ? | Maybe<Scalars[String][]> |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2324 (opens new window)
# EnumField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2332 (opens new window)
# EnumType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2338 (opens new window)
# EnumTypeDraft
# Type declaration:
Name | Type |
---|---|
values | PlainEnumValueDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2344 (opens new window)
# EnumValue
# Type declaration:
Name | Type |
---|---|
__typename ? | EnumValue |
key | Scalars[String] |
label | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2348 (opens new window)
# ExternalDiscountValue
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2354 (opens new window)
# ExternalDiscountValueInput
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2359 (opens new window)
# ExternalLineItemTotalPriceDraft
# Type declaration:
Name | Type |
---|---|
price | BaseMoneyInput |
totalPrice | MoneyInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2363 (opens new window)
# ExternalOAuth
# Type declaration:
Name | Type |
---|---|
__typename ? | ExternalOAuth |
authorizationHeader | Scalars[String] |
url | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2368 (opens new window)
# ExternalOAuthDraft
# Type declaration:
Name | Type |
---|---|
authorizationHeader | Scalars[String] |
url | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2374 (opens new window)
# ExternalTaxAmountDraft
# Type declaration:
Name | Type |
---|---|
taxRate | ExternalTaxRateDraft |
totalGross | MoneyInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2379 (opens new window)
# ExternalTaxRateDraft
# Type declaration:
Name | Type |
---|---|
amount | Scalars[Float] |
country | Scalars[Country] |
includedInPrice ? | Maybe<Scalars[Boolean]> |
name | Scalars[String] |
state ? | Maybe<Scalars[String]> |
subRates ? | Maybe<SubRateDraft[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2384 (opens new window)
# FieldDefinition
Field definitions describe custom fields and allow you to define some meta-information associated with the field.
# Type declaration:
Name | Type |
---|---|
__typename ? | FieldDefinition |
inputHint | TextInputHint |
label ? | Maybe<Scalars[String]> |
labelAllLocales | LocalizedString[] |
name | Scalars[String] |
required | Scalars[Boolean] |
type | FieldType |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2394 (opens new window)
# FieldDefinitionLabelArgs
Field definitions describe custom fields and allow you to define some meta-information associated with the field.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2405 (opens new window)
# FieldType
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2410 (opens new window)
# Geometry
# Type declaration:
Name | Type |
---|---|
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2414 (opens new window)
# GiftLineItemValue
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2418 (opens new window)
# GiftLineItemValueInput
# Type declaration:
Name | Type |
---|---|
distributionChannel ? | Maybe<ResourceIdentifierInput> |
product | ResourceIdentifierInput |
supplyChannel ? | Maybe<ResourceIdentifierInput> |
variantId | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2427 (opens new window)
# HighPrecisionMoney
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2434 (opens new window)
# HighPrecisionMoneyInput
# Type declaration:
Name | Type |
---|---|
centAmount ? | Maybe<Scalars[Long]> |
currencyCode | Scalars[Currency] |
fractionDigits | Scalars[Int] |
preciseAmount | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2443 (opens new window)
# IOsUserType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2698 (opens new window)
# Image
# Type declaration:
Name | Type |
---|---|
__typename ? | Image |
dimensions | Dimensions |
label ? | Maybe<Scalars[String]> |
url | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2450 (opens new window)
# ImageInput
# Type declaration:
Name | Type |
---|---|
dimensions | DimensionsInput |
label ? | Maybe<Scalars[String]> |
url | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2457 (opens new window)
# ImportOrderCustomLineItemState
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
state | ItemStateDraftType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2463 (opens new window)
# ImportOrderLineItemState
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
state | ItemStateDraftType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2468 (opens new window)
# InStore
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2483 (opens new window)
# InStoreCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2523 (opens new window)
# InStoreCartsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2527 (opens new window)
# InStoreCustomerActiveCartArgs
# Type declaration:
Name | Type |
---|---|
customerId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2534 (opens new window)
# InStoreCustomerArgs
# Type declaration:
Name | Type |
---|---|
emailToken ? | Maybe<Scalars[String]> |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
passwordToken ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2509 (opens new window)
# InStoreCustomersArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2516 (opens new window)
# InStoreMe
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2550 (opens new window)
# InStoreMeCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2562 (opens new window)
# InStoreMeCartsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2566 (opens new window)
# InStoreMeOrderArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2573 (opens new window)
# InStoreMeOrdersArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2578 (opens new window)
# InStoreMeShoppingListArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2585 (opens new window)
# InStoreMeShoppingListsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2590 (opens new window)
# InStoreOrderArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2538 (opens new window)
# InStoreOrdersArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2543 (opens new window)
# InStoreShippingMethodsByCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2505 (opens new window)
# Initiator
# Type declaration:
Name | Type |
---|---|
__typename ? | Initiator |
anonymousId ? | Maybe<Scalars[String]> |
clientId ? | Maybe<Scalars[String]> |
customer ? | Maybe<Reference> |
externalUserId ? | Maybe<Scalars[String]> |
isPlatformClient ? | Maybe<Scalars[Boolean]> |
user ? | Maybe<Reference> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2473 (opens new window)
# InterfaceInteractionsRaw
# Type declaration:
Name | Type |
---|---|
__typename ? | InterfaceInteractionsRaw |
fields | RawCustomField[] |
type ? | Maybe<TypeDefinition> |
typeRef | Reference |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2597 (opens new window)
# InterfaceInteractionsRawFieldsArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2604 (opens new window)
# InterfaceInteractionsRawResult
# Type declaration:
Name | Type |
---|---|
__typename ? | InterfaceInteractionsRawResult |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
results | InterfaceInteractionsRaw[] |
total | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2609 (opens new window)
# InventoryEntry
Inventory allows you to track stock quantity per SKU and optionally per supply channel
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2618 (opens new window)
# InventoryEntryCustomFieldListArgs
Inventory allows you to track stock quantity per SKU and optionally per supply channel
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2648 (opens new window)
# InventoryEntryCustomFieldsRawArgs
Inventory allows you to track stock quantity per SKU and optionally per supply channel
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2642 (opens new window)
# InventoryEntryDraft
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
expectedDelivery ? | Maybe<Scalars[DateTime]> |
quantityOnStock ? | Maybe<Scalars[Long]> |
restockableInDays ? | Maybe<Scalars[Int]> |
sku | Scalars[String] |
supplyChannel ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2653 (opens new window)
# InventoryEntryQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | InventoryEntryQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | InventoryEntry[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2662 (opens new window)
# InventoryEntryUpdateAction
# Type declaration:
Name | Type |
---|---|
addQuantity ? | Maybe<AddInventoryEntryQuantity> |
changeQuantity ? | Maybe<ChangeInventoryEntryQuantity> |
removeQuantity ? | Maybe<RemoveInventoryEntryQuantity> |
setCustomField ? | Maybe<SetInventoryEntryCustomField> |
setCustomType ? | Maybe<SetInventoryEntryCustomType> |
setExpectedDelivery ? | Maybe<SetInventoryEntryExpectedDelivery> |
setRestockableInDays ? | Maybe<SetInventoryEntryRestockableInDays> |
setSupplyChannel ? | Maybe<SetInventoryEntrySupplyChannel> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2670 (opens new window)
# ItemShippingDetails
# Type declaration:
Name | Type |
---|---|
__typename ? | ItemShippingDetails |
targets | ItemShippingTarget[] |
valid | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2706 (opens new window)
# ItemShippingDetailsDraft
# Type declaration:
Name | Type |
---|---|
targets | ShippingTargetDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2712 (opens new window)
# ItemShippingDetailsDraftType
# Type declaration:
Name | Type |
---|---|
targets | ShippingTargetDraftType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2716 (opens new window)
# ItemShippingTarget
# Type declaration:
Name | Type |
---|---|
__typename ? | ItemShippingTarget |
addressKey | Scalars[String] |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2720 (opens new window)
# ItemState
# Type declaration:
Name | Type |
---|---|
__typename ? | ItemState |
quantity | Scalars[Long] |
state ? | Maybe<State> |
stateRef | Reference |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2726 (opens new window)
# ItemStateDraftType
# Type declaration:
Name | Type |
---|---|
quantity | Scalars[Long] |
state | ReferenceInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2733 (opens new window)
# KeyReference
# Type declaration:
Name | Type |
---|---|
__typename ? | KeyReference |
key | Scalars[String] |
typeId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2738 (opens new window)
# LineItem
A line item is a snapshot of a product variant at the time it was added to the cart.
Since a product variant may change at any time, the ProductVariant data is copied into the field variant. The relation to the Product is kept but the line item will not automatically update if the product variant changes. On the cart, the line item can be updated manually. The productSlug refers to the current version of the product. It can be used to link to the product. If the product has been deleted, the line item remains but refers to a non-existent product and the productSlug is left empty.
Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | LineItem | - |
custom ? | Maybe<CustomFieldsType> | - |
customFieldList ? | Maybe<CustomField[]> | Custom fields are returned as a list instead of an object structure. |
customFields ? | Maybe<Type> | This field would contain type data |
customFieldsRaw ? | Maybe<RawCustomField[]> | This field contains non-typed data. Consider using customFields as a typed alternative. |
discountedPricePerQuantity | DiscountedLineItemPriceForQuantity[] | - |
distributionChannel ? | Maybe<Channel> | - |
distributionChannelRef ? | Maybe<Reference> | - |
id | Scalars[String] | - |
inventoryMode ? | Maybe<ItemShippingDetails> | - |
lineItemMode | LineItemMode | - |
name ? | Maybe<Scalars[String]> | - |
nameAllLocales | LocalizedString[] | - |
price | ProductPrice | - |
priceMode | LineItemPriceMode | - |
productId | Scalars[String] | - |
productSlug ? | Maybe<Scalars[String]> | - |
productType ? | Maybe<ProductTypeDefinition> | - |
productTypeRef ? | Maybe<Reference> | - |
quantity | Scalars[Long] | - |
shippingDetails ? | Maybe<ItemShippingDetails> | - |
state | ItemState[] | - |
supplyChannel ? | Maybe<Channel> | - |
supplyChannelRef ? | Maybe<Reference> | - |
taxRate ? | Maybe<TaxRate> | - |
taxedPrice ? | Maybe<TaxedItemPrice> | - |
totalPrice ? | Maybe<Money> | - |
variant ? | Maybe<ProductVariant> | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2755 (opens new window)
# LineItemCustomFieldListArgs
A line item is a snapshot of a product variant at the time it was added to the cart.
Since a product variant may change at any time, the ProductVariant data is copied into the field variant. The relation to the Product is kept but the line item will not automatically update if the product variant changes. On the cart, the line item can be updated manually. The productSlug refers to the current version of the product. It can be used to link to the product. If the product has been deleted, the line item remains but refers to a non-existent product and the productSlug is left empty.
Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2848 (opens new window)
# LineItemCustomFieldsRawArgs
A line item is a snapshot of a product variant at the time it was added to the cart.
Since a product variant may change at any time, the ProductVariant data is copied into the field variant. The relation to the Product is kept but the line item will not automatically update if the product variant changes. On the cart, the line item can be updated manually. The productSlug refers to the current version of the product. It can be used to link to the product. If the product has been deleted, the line item remains but refers to a non-existent product and the productSlug is left empty.
Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2832 (opens new window)
# LineItemDraft
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
distributionChannel ? | Maybe<ResourceIdentifierInput> |
externalPrice ? | Maybe<BaseMoneyInput> |
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
externalTotalPrice ? | Maybe<ExternalLineItemTotalPriceDraft> |
productId ? | Maybe<Scalars[String]> |
quantity ? | Maybe<Scalars[Long]> |
shippingDetails ? | Maybe<ItemShippingDetailsDraft> |
sku ? | Maybe<Scalars[String]> |
supplyChannel ? | Maybe<ResourceIdentifierInput> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2853 (opens new window)
# LineItemNameArgs
A line item is a snapshot of a product variant at the time it was added to the cart.
Since a product variant may change at any time, the ProductVariant data is copied into the field variant. The relation to the Product is kept but the line item will not automatically update if the product variant changes. On the cart, the line item can be updated manually. The productSlug refers to the current version of the product. It can be used to link to the product. If the product has been deleted, the line item remains but refers to a non-existent product and the productSlug is left empty.
Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2800 (opens new window)
# LineItemProductSlugArgs
A line item is a snapshot of a product variant at the time it was added to the cart.
Since a product variant may change at any time, the ProductVariant data is copied into the field variant. The relation to the Product is kept but the line item will not automatically update if the product variant changes. On the cart, the line item can be updated manually. The productSlug refers to the current version of the product. It can be used to link to the product. If the product has been deleted, the line item remains but refers to a non-existent product and the productSlug is left empty.
Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2816 (opens new window)
# LineItemReturnItem
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2893 (opens new window)
# LineItemsTarget
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2906 (opens new window)
# LineItemsTargetInput
# Type declaration:
Name | Type |
---|---|
predicate | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2912 (opens new window)
# LocalizableEnumAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2916 (opens new window)
# LocalizableEnumAttributeDefinitionTypeValuesArgs
# Type declaration:
Name | Type |
---|---|
excludeKeys ? | Maybe<Scalars[String][]> |
includeKeys ? | Maybe<Scalars[String][]> |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2922 (opens new window)
# LocalizableEnumTypeDraft
# Type declaration:
Name | Type |
---|---|
values | LocalizedEnumValueDraft[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2930 (opens new window)
# LocalizableEnumValueType
# Type declaration:
Name | Type |
---|---|
__typename ? | LocalizableEnumValueType |
key | Scalars[String] |
label ? | Maybe<Scalars[String]> |
labelAllLocales | LocalizedString[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2934 (opens new window)
# LocalizableEnumValueTypeLabelArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2941 (opens new window)
# LocalizableEnumValueTypeResult
# Type declaration:
Name | Type |
---|---|
__typename ? | LocalizableEnumValueTypeResult |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
results | LocalizableEnumValueType[] |
total | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2946 (opens new window)
# LocalizableTextAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2954 (opens new window)
# LocalizedEnumAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2959 (opens new window)
# LocalizedEnumAttributeLabelArgs
# Type declaration:
Name | Type |
---|---|
locale | Scalars[Locale] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2966 (opens new window)
# LocalizedEnumField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2970 (opens new window)
# LocalizedEnumFieldLabelArgs
# Type declaration:
Name | Type |
---|---|
locale | Scalars[Locale] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2977 (opens new window)
# LocalizedEnumType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2981 (opens new window)
# LocalizedEnumValue
# Type declaration:
Name | Type |
---|---|
__typename ? | LocalizedEnumValue |
key | Scalars[String] |
label ? | Maybe<Scalars[String]> |
labelAllLocales | LocalizedString[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2987 (opens new window)
# LocalizedEnumValueDraft
# Type declaration:
Name | Type |
---|---|
key | Scalars[String] |
label | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2999 (opens new window)
# LocalizedEnumValueInput
# Type declaration:
Name | Type |
---|---|
key | Scalars[String] |
label | LocalizedStringItemInputType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3004 (opens new window)
# LocalizedEnumValueLabelArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:2994 (opens new window)
# LocalizedString
# Type declaration:
Name | Type |
---|---|
__typename ? | LocalizedString |
locale | Scalars[Locale] |
value | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3009 (opens new window)
# LocalizedStringAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3015 (opens new window)
# LocalizedStringAttributeValueArgs
# Type declaration:
Name | Type |
---|---|
locale | Scalars[Locale] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3021 (opens new window)
# LocalizedStringField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3025 (opens new window)
# LocalizedStringFieldValueArgs
# Type declaration:
Name | Type |
---|---|
locale | Scalars[Locale] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3031 (opens new window)
# LocalizedStringItemInputType
# Type declaration:
Name | Type |
---|---|
locale | Scalars[Locale] |
value | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3035 (opens new window)
# LocalizedStringType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3040 (opens new window)
# LocalizedText
# Type declaration:
Name | Type |
---|---|
locale | Scalars[Locale] |
text | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3045 (opens new window)
# Location
# Type declaration:
Name | Type |
---|---|
__typename ? | Location |
country | Scalars[Country] |
state ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3050 (opens new window)
# MainProductType
Sunrise Product Data Set Structure
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3057 (opens new window)
# Maybe
# Type parameters:
Name |
---|
T |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3 (opens new window)
# Me
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3083 (opens new window)
# MeCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3095 (opens new window)
# MeCartsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3099 (opens new window)
# MeFieldInterface
The me field gives access to the data that is specific to the customer or anonymous session linked to the access token.
# Type declaration:
Name | Type |
---|---|
me | MeQueryInterface |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3131 (opens new window)
# MeOrderArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3106 (opens new window)
# MeOrdersArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3111 (opens new window)
# MeQueryInterface
# Type declaration:
Name | Type |
---|---|
activeCart ? | Maybe<Cart> |
cart ? | Maybe<Cart> |
carts | CartQueryResult |
order ? | Maybe<Order> |
orders | OrderQueryResult |
shoppingList ? | Maybe<ShoppingList> |
shoppingLists | ShoppingListQueryResult |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3135 (opens new window)
# MeQueryInterfaceCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3145 (opens new window)
# MeQueryInterfaceCartsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3149 (opens new window)
# MeQueryInterfaceOrderArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3156 (opens new window)
# MeQueryInterfaceOrdersArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3161 (opens new window)
# MeQueryInterfaceShoppingListArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3168 (opens new window)
# MeQueryInterfaceShoppingListsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3173 (opens new window)
# MeShoppingListArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3118 (opens new window)
# MeShoppingListsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3123 (opens new window)
# MessagesConfiguration
# Type declaration:
Name | Type |
---|---|
__typename ? | MessagesConfiguration |
deleteDaysAfterCreation ? | Maybe<Scalars[Int]> |
enabled | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3180 (opens new window)
# MessagesConfigurationDraft
# Type declaration:
Name | Type |
---|---|
deleteDaysAfterCreation | Scalars[Int] |
enabled | Scalars[Boolean] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3186 (opens new window)
# Money
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3191 (opens new window)
# MoneyAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3200 (opens new window)
# MoneyAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3207 (opens new window)
# MoneyDraft
# Type declaration:
Name | Type |
---|---|
centAmount | Scalars[Long] |
currencyCode | Scalars[Currency] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3212 (opens new window)
# MoneyField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3217 (opens new window)
# MoneyInput
# Type declaration:
Name | Type |
---|---|
centAmount | Scalars[Long] |
currencyCode | Scalars[Currency] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3224 (opens new window)
# MoneyType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3229 (opens new window)
# MoveProductImageToPosition
# Type declaration:
Name | Type |
---|---|
imageUrl | Scalars[String] |
position | Scalars[Int] |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3234 (opens new window)
# MultiBuyCustomLineItemsTarget
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3242 (opens new window)
# MultiBuyCustomLineItemsTargetInput
# Type declaration:
Name | Type |
---|---|
discountedQuantity | Scalars[Long] |
maxOccurrence ? | Maybe<Scalars[Int]> |
predicate | Scalars[String] |
selectionMode ? | Maybe<SelectionMode> |
triggerQuantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3252 (opens new window)
# MultiBuyLineItemsTarget
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3260 (opens new window)
# MultiBuyLineItemsTargetInput
# Type declaration:
Name | Type |
---|---|
discountedQuantity | Scalars[Long] |
maxOccurrence ? | Maybe<Scalars[Int]> |
predicate | Scalars[String] |
selectionMode ? | Maybe<SelectionMode> |
triggerQuantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3270 (opens new window)
# Mutation
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | Mutation | - |
createApiClient ? | Maybe<ApiClientWithSecret> | - |
createCart ? | Maybe<Cart> | - |
createCartDiscount ? | Maybe<CartDiscount> | - |
createCategory ? | Maybe<Category> | - |
createCustomerGroup ? | Maybe<CustomerGroup> | - |
createDiscountCode ? | Maybe<DiscountCode> | - |
createInventoryEntry ? | Maybe<InventoryEntry> | - |
createMyCart ? | Maybe<Cart> | - |
createMyOrderFromCart ? | Maybe<Order> | - |
createMyShoppingList ? | Maybe<ShoppingList> | - |
createOrderFromCart ? | Maybe<Order> | - |
createProduct ? | Maybe<Product> | - |
createProductDiscount ? | Maybe<ProductDiscount> | - |
createProductType ? | Maybe<ProductTypeDefinition> | - |
createShippingMethod ? | Maybe<ShippingMethod> | - |
createShoppingList ? | Maybe<ShoppingList> | - |
createStore ? | Maybe<Store> | - |
createTaxCategory ? | Maybe<TaxCategory> | - |
createZone ? | Maybe<Zone> | - |
customerChangeMyPassword ? | Maybe<Customer> | - |
customerChangePassword ? | Maybe<Customer> | - |
customerConfirmEmail ? | Maybe<Customer> | Verifies customer's email using a token. |
customerConfirmMyEmail ? | Maybe<Customer> | - |
customerCreateEmailVerificationToken | CustomerToken | - |
customerCreatePasswordResetToken ? | Maybe<CustomerToken> | The token value is used to reset the password of the customer with the given email. The token is valid only for 10 minutes. |
customerResetMyPassword ? | Maybe<Customer> | - |
customerResetPassword ? | Maybe<Customer> | The following workflow can be used to reset the customer’s password: 1. Create a password reset token and send it embedded in a link to the customer. 2. When the customer clicks on the link, you may optionally retrieve customer by password token. 3. When the customer entered new password, use reset customer’s password to reset the password. |
customerSignIn | CustomerSignInResult | Retrieves the authenticated customer (a customer that matches the given email/password pair). There may be carts and orders created before the sign in that should be assigned to the customer account. With the anonymousCartId , a single anonymous cart can be assigned. With the anonymousId , all orders and carts that have this anonymousId set will be assigned to the customer. If both anonymousCartId and anonymousId are given, the anonymous cart must have the anonymousId . Additionally, there might also exist one or more active customer carts from an earlier session. On customer sign in there are several ways how to proceed with this cart and the cart referenced by the anonymousCartId . * If the customer does not have a cart yet, the anonymous cart becomes the customer's cart. * If the customer already has one or more carts, the content of the anonymous cart will be copied to the customer's active cart that has been modified most recently. In this case the CartState of the anonymous cart gets changed to Merged while the customer's cart remains the Active cart. If a LineItem in the anonymous cart matches an existing line item, or a CustomLineItem matches an existing custom line item in the customer's cart, the maximum quantity of both line items is used as the new quantity. ItemShippingDetails are copied from the item with the highest quantity. If itemShippingAddresses are different in the two carts, the resulting cart contains the addresses of both the customer cart and the anonymous cart. Note, that it is not possible to merge carts that differ in their currency (set during creation of the cart). If a cart is is returned as part of the CustomerSignInResult , it has been recalculated (it will have up-to-date prices, taxes and discounts, and invalid line items have been removed). |
customerSignMeIn | CustomerSignInResult | Retrieves the authenticated customer (a customer that matches the given email/password pair). If used with an access token for Anonymous Sessions, all orders and carts belonging to the anonymousId will be assigned to the newly created customer. * If the customer does not have a cart yet, the anonymous cart that was modified most recently becomes the customer's cart. * If the customer already has a cart, the most recently modified anonymous cart will be handled according to the AnonymousCartSignInMode . If a cart is is returned as part of the CustomerSignInResult , it has been recalculated (it will have up-to-date prices, taxes and discounts, and invalid line items have been removed). |
customerSignMeUp | CustomerSignInResult | If used with an access token for Anonymous Sessions, all orders and carts belonging to the anonymousId will be assigned to the newly created customer. |
customerSignUp | CustomerSignInResult | Creates a customer. If an anonymous cart is given then the cart is assigned to the created customer and the version number of the Cart will increase. If the id of an anonymous session is given, all carts and orders will be assigned to the created customer. |
deleteApiClient ? | Maybe<ApiClientWithoutSecret> | - |
deleteCart ? | Maybe<Cart> | - |
deleteCartDiscount ? | Maybe<CartDiscount> | - |
deleteCategory ? | Maybe<Category> | - |
deleteCustomer ? | Maybe<Customer> | - |
deleteCustomerGroup ? | Maybe<CustomerGroup> | - |
deleteDiscountCode ? | Maybe<DiscountCode> | - |
deleteInventoryEntry ? | Maybe<InventoryEntry> | - |
deleteMyCart ? | Maybe<Cart> | - |
deleteMyCustomer ? | Maybe<Customer> | - |
deleteMyShoppingList ? | Maybe<ShoppingList> | - |
deleteOrder ? | Maybe<Order> | - |
deleteProduct ? | Maybe<Product> | - |
deleteProductDiscount ? | Maybe<ProductDiscount> | - |
deleteProductType ? | Maybe<ProductTypeDefinition> | - |
deleteShippingMethod ? | Maybe<ShippingMethod> | - |
deleteShoppingList ? | Maybe<ShoppingList> | - |
deleteStore ? | Maybe<Store> | - |
deleteTaxCategory ? | Maybe<TaxCategory> | - |
deleteZone ? | Maybe<Zone> | - |
replicateCart ? | Maybe<Cart> | - |
updateCart ? | Maybe<Cart> | - |
updateCartDiscount ? | Maybe<CartDiscount> | - |
updateCategory ? | Maybe<Category> | - |
updateCustomer ? | Maybe<Customer> | - |
updateCustomerGroup ? | Maybe<CustomerGroup> | - |
updateDiscountCode ? | Maybe<DiscountCode> | - |
updateInventoryEntry ? | Maybe<InventoryEntry> | - |
updateMyCart ? | Maybe<Cart> | - |
updateMyCustomer ? | Maybe<Customer> | - |
updateMyShoppingList ? | Maybe<ShoppingList> | - |
updateOrder ? | Maybe<Order> | - |
updateProduct ? | Maybe<Product> | - |
updateProductDiscount ? | Maybe<ProductDiscount> | - |
updateProductType ? | Maybe<ProductTypeDefinition> | - |
updateProject ? | Maybe<ProjectProjection> | - |
updateShippingMethod ? | Maybe<ShippingMethod> | - |
updateShoppingList ? | Maybe<ShoppingList> | - |
updateStore ? | Maybe<Store> | - |
updateTaxCategory ? | Maybe<TaxCategory> | - |
updateZone ? | Maybe<Zone> | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3278 (opens new window)
# MutationCreateApiClientArgs
# Type declaration:
Name | Type |
---|---|
draft | CreateApiClient |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3825 (opens new window)
# MutationCreateCartArgs
# Type declaration:
Name | Type |
---|---|
draft | CartDraft |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3703 (opens new window)
# MutationCreateCartDiscountArgs
# Type declaration:
Name | Type |
---|---|
draft | CartDiscountDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3537 (opens new window)
# MutationCreateCategoryArgs
# Type declaration:
Name | Type |
---|---|
draft | CategoryDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3437 (opens new window)
# MutationCreateCustomerGroupArgs
# Type declaration:
Name | Type |
---|---|
draft | CustomerGroupDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3420 (opens new window)
# MutationCreateDiscountCodeArgs
# Type declaration:
Name | Type |
---|---|
draft | DiscountCodeDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3522 (opens new window)
# MutationCreateInventoryEntryArgs
# Type declaration:
Name | Type |
---|---|
draft | InventoryEntryDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3688 (opens new window)
# MutationCreateMyCartArgs
# Type declaration:
Name | Type |
---|---|
draft | MyCartDraft |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3726 (opens new window)
# MutationCreateMyOrderFromCartArgs
# Type declaration:
Name | Type |
---|---|
draft | OrderMyCartCommand |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3765 (opens new window)
# MutationCreateMyShoppingListArgs
# Type declaration:
Name | Type |
---|---|
draft | MyShoppingListDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3788 (opens new window)
# MutationCreateOrderFromCartArgs
# Type declaration:
Name | Type |
---|---|
draft | OrderCartCommand |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3744 (opens new window)
# MutationCreateProductArgs
# Type declaration:
Name | Type |
---|---|
draft | ProductDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3571 (opens new window)
# MutationCreateProductDiscountArgs
# Type declaration:
Name | Type |
---|---|
draft | ProductDiscountDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3554 (opens new window)
# MutationCreateProductTypeArgs
# Type declaration:
Name | Type |
---|---|
draft | ProductTypeDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3454 (opens new window)
# MutationCreateShippingMethodArgs
# Type declaration:
Name | Type |
---|---|
draft | ShippingMethodDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3471 (opens new window)
# MutationCreateShoppingListArgs
# Type declaration:
Name | Type |
---|---|
draft | ShoppingListDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3770 (opens new window)
# MutationCreateStoreArgs
# Type declaration:
Name | Type |
---|---|
draft | CreateStore |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3808 (opens new window)
# MutationCreateTaxCategoryArgs
# Type declaration:
Name | Type |
---|---|
draft | TaxCategoryDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3505 (opens new window)
# MutationCreateZoneArgs
# Type declaration:
Name | Type |
---|---|
draft | CreateZone |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3488 (opens new window)
# MutationCustomerChangeMyPasswordArgs
# Type declaration:
Name | Type |
---|---|
currentPassword | Scalars[String] |
newPassword | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3670 (opens new window)
# MutationCustomerChangePasswordArgs
# Type declaration:
Name | Type |
---|---|
currentPassword | Scalars[String] |
id | Scalars[String] |
newPassword | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3614 (opens new window)
# MutationCustomerConfirmEmailArgs
# Type declaration:
Name | Type |
---|---|
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
tokenValue | Scalars[String] |
version ? | Maybe<Scalars[Long]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3629 (opens new window)
# MutationCustomerConfirmMyEmailArgs
# Type declaration:
Name | Type |
---|---|
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
tokenValue | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3677 (opens new window)
# MutationCustomerCreateEmailVerificationTokenArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
ttlMinutes | Scalars[Int] |
version ? | Maybe<Scalars[Long]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3641 (opens new window)
# MutationCustomerCreatePasswordResetTokenArgs
# Type declaration:
Name | Type |
---|---|
email | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
ttlMinutes ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3635 (opens new window)
# MutationCustomerResetMyPasswordArgs
# Type declaration:
Name | Type |
---|---|
newPassword | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
tokenValue | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3682 (opens new window)
# MutationCustomerResetPasswordArgs
# Type declaration:
Name | Type |
---|---|
newPassword | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
tokenValue | Scalars[String] |
version ? | Maybe<Scalars[Long]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3622 (opens new window)
# MutationCustomerSignInArgs
# Type declaration:
Name | Type |
---|---|
draft | CustomerSignInDraft |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3593 (opens new window)
# MutationCustomerSignMeInArgs
# Type declaration:
Name | Type |
---|---|
draft | CustomerSignMeInDraft |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3653 (opens new window)
# MutationCustomerSignMeUpArgs
# Type declaration:
Name | Type |
---|---|
draft | CustomerSignMeUpDraft |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3648 (opens new window)
# MutationCustomerSignUpArgs
# Type declaration:
Name | Type |
---|---|
draft | CustomerSignUpDraft |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3588 (opens new window)
# MutationDeleteApiClientArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3829 (opens new window)
# MutationDeleteCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
personalDataErasure ? | Maybe<Scalars[Boolean]> |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3715 (opens new window)
# MutationDeleteCartDiscountArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3548 (opens new window)
# MutationDeleteCategoryArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3448 (opens new window)
# MutationDeleteCustomerArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
personalDataErasure ? | Maybe<Scalars[Boolean]> |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3606 (opens new window)
# MutationDeleteCustomerGroupArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3431 (opens new window)
# MutationDeleteDiscountCodeArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3532 (opens new window)
# MutationDeleteInventoryEntryArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3698 (opens new window)
# MutationDeleteMyCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3738 (opens new window)
# MutationDeleteMyCustomerArgs
# Type declaration:
Name | Type |
---|---|
personalDataErasure ? | Maybe<Scalars[Boolean]> |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3664 (opens new window)
# MutationDeleteMyShoppingListArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3798 (opens new window)
# MutationDeleteOrderArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
personalDataErasure ? | Maybe<Scalars[Boolean]> |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3757 (opens new window)
# MutationDeleteProductArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3582 (opens new window)
# MutationDeleteProductDiscountArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3565 (opens new window)
# MutationDeleteProductTypeArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3465 (opens new window)
# MutationDeleteShippingMethodArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3482 (opens new window)
# MutationDeleteShoppingListArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
personalDataErasure ? | Maybe<Scalars[Boolean]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3781 (opens new window)
# MutationDeleteStoreArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3819 (opens new window)
# MutationDeleteTaxCategoryArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3516 (opens new window)
# MutationDeleteZoneArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3499 (opens new window)
# MutationReplicateCartArgs
# Type declaration:
Name | Type |
---|---|
reference | ReferenceInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3722 (opens new window)
# MutationUpdateCartArgs
# Type declaration:
Name | Type |
---|---|
actions | CartUpdateAction[] |
id | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3708 (opens new window)
# MutationUpdateCartDiscountArgs
# Type declaration:
Name | Type |
---|---|
actions | CartDiscountUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3541 (opens new window)
# MutationUpdateCategoryArgs
# Type declaration:
Name | Type |
---|---|
actions | CategoryUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3441 (opens new window)
# MutationUpdateCustomerArgs
# Type declaration:
Name | Type |
---|---|
actions | CustomerUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3598 (opens new window)
# MutationUpdateCustomerGroupArgs
# Type declaration:
Name | Type |
---|---|
actions | CustomerGroupUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3424 (opens new window)
# MutationUpdateDiscountCodeArgs
# Type declaration:
Name | Type |
---|---|
actions | DiscountCodeUpdateAction[] |
id | Scalars[String] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3526 (opens new window)
# MutationUpdateInventoryEntryArgs
# Type declaration:
Name | Type |
---|---|
actions | InventoryEntryUpdateAction[] |
id | Scalars[String] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3692 (opens new window)
# MutationUpdateMyCartArgs
# Type declaration:
Name | Type |
---|---|
actions | MyCartUpdateAction[] |
id | Scalars[String] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3731 (opens new window)
# MutationUpdateMyCustomerArgs
# Type declaration:
Name | Type |
---|---|
actions | MyCustomerUpdateAction[] |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3658 (opens new window)
# MutationUpdateMyShoppingListArgs
# Type declaration:
Name | Type |
---|---|
actions | MyShoppingListUpdateAction[] |
id | Scalars[String] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3792 (opens new window)
# MutationUpdateOrderArgs
# Type declaration:
Name | Type |
---|---|
actions | OrderUpdateAction[] |
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
storeKey ? | Maybe<Scalars[KeyReferenceInput]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3749 (opens new window)
# MutationUpdateProductArgs
# Type declaration:
Name | Type |
---|---|
actions | ProductUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3575 (opens new window)
# MutationUpdateProductDiscountArgs
# Type declaration:
Name | Type |
---|---|
actions | ProductDiscountUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3558 (opens new window)
# MutationUpdateProductTypeArgs
# Type declaration:
Name | Type |
---|---|
actions | ProductTypeUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3458 (opens new window)
# MutationUpdateProjectArgs
# Type declaration:
Name | Type |
---|---|
actions | ProjectSettingsUpdateAction[] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3803 (opens new window)
# MutationUpdateShippingMethodArgs
# Type declaration:
Name | Type |
---|---|
actions | ShippingMethodUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3475 (opens new window)
# MutationUpdateShoppingListArgs
# Type declaration:
Name | Type |
---|---|
actions | ShoppingListUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3774 (opens new window)
# MutationUpdateStoreArgs
# Type declaration:
Name | Type |
---|---|
actions | StoreUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3812 (opens new window)
# MutationUpdateTaxCategoryArgs
# Type declaration:
Name | Type |
---|---|
actions | TaxCategoryUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3509 (opens new window)
# MutationUpdateZoneArgs
# Type declaration:
Name | Type |
---|---|
actions | ZoneUpdateAction[] |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3492 (opens new window)
# MyCartDraft
# Type declaration:
Name | Type |
---|---|
billingAddress ? | Maybe<AddressInput> |
country ? | Maybe<Scalars[Country]> |
currency | Scalars[Currency] |
custom ? | Maybe<CustomFieldsDraft> |
customerEmail ? | Maybe<Scalars[String]> |
deleteDaysAfterLastModification ? | Maybe<Scalars[Int]> |
discountCodes ? | Maybe<Scalars[String][]> |
inventoryMode ? | Maybe<InventoryMode> |
itemShippingAddresses ? | Maybe<AddressInput[]> |
lineItems ? | Maybe<MyLineItemDraft[]> |
locale ? | Maybe<Scalars[Locale]> |
shippingAddress ? | Maybe<AddressInput> |
shippingMethod ? | Maybe<ResourceIdentifierInput> |
taxMode ? | Maybe<TaxMode> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3833 (opens new window)
# MyCartUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3850 (opens new window)
# MyCustomerUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3883 (opens new window)
# MyLineItemDraft
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
distributionChannel ? | Maybe<ResourceIdentifierInput> |
productId ? | Maybe<Scalars[String]> |
quantity ? | Maybe<Scalars[Long]> |
shippingDetails ? | Maybe<ItemShippingDetailsDraft> |
sku ? | Maybe<Scalars[String]> |
supplyChannel ? | Maybe<ResourceIdentifierInput> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3907 (opens new window)
# MyShoppingListDraft
# Type declaration:
Name | Type |
---|---|
custom ? | Maybe<CustomFieldsDraft> |
deleteDaysAfterLastModification ? | Maybe<Scalars[Int]> |
description ? | Maybe<LocalizedStringItemInputType[]> |
lineItems ? | Maybe<ShoppingListLineItemDraft[]> |
name | LocalizedStringItemInputType[] |
textLineItems ? | Maybe<TextLineItemDraft[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3918 (opens new window)
# MyShoppingListUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3927 (opens new window)
# NestedAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3951 (opens new window)
# NumberAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3957 (opens new window)
# NumberAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3963 (opens new window)
# NumberField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3968 (opens new window)
# NumberType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3974 (opens new window)
# Order
An order can be created from a cart, usually after a checkout process has been completed. documentation (opens new window)
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:3982 (opens new window)
# OrderCartCommand
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
orderNumber ? | Maybe<Scalars[String]> |
orderState ? | Maybe<OrderState> |
paymentState ? | Maybe<PaymentState> |
shipmentState ? | Maybe<ShipmentState> |
state ? | Maybe<ReferenceInput> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4055 (opens new window)
# OrderMyCartCommand
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4065 (opens new window)
# OrderQueryInterface
Fields to access orders. Includes direct access to a single order and searching for orders.
# Type declaration:
Name | Type |
---|---|
order ? | Maybe<Order> |
orders | OrderQueryResult |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4071 (opens new window)
# OrderQueryInterfaceOrderArgs
Fields to access orders. Includes direct access to a single order and searching for orders.
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4077 (opens new window)
# OrderQueryInterfaceOrdersArgs
Fields to access orders. Includes direct access to a single order and searching for orders.
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4083 (opens new window)
# OrderQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | OrderQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Order[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4090 (opens new window)
# OrderUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4105 (opens new window)
# Parcel
# Type declaration:
Name | Type |
---|---|
__typename ? | Parcel |
createdAt | Scalars[DateTime] |
id | Scalars[String] |
items | DeliveryItem[] |
measurements ? | Maybe<ParcelMeasurements> |
trackingData ? | Maybe<TrackingData> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4150 (opens new window)
# ParcelMeasurements
# Type declaration:
Name | Type |
---|---|
__typename ? | ParcelMeasurements |
heightInMillimeter ? | Maybe<Scalars[Int]> |
lengthInMillimeter ? | Maybe<Scalars[Int]> |
weightInGram ? | Maybe<Scalars[Int]> |
widthInMillimeter ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4159 (opens new window)
# ParcelMeasurementsDraftType
# Type declaration:
Name | Type |
---|---|
heightInMillimeter ? | Maybe<Scalars[Int]> |
lengthInMillimeter ? | Maybe<Scalars[Int]> |
weightInGram ? | Maybe<Scalars[Int]> |
widthInMillimeter ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4167 (opens new window)
# Payment
Payments hold information about the current state of receiving and/or refunding money. documentation (opens new window)
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4177 (opens new window)
# PaymentInfo
# Type declaration:
Name | Type |
---|---|
__typename ? | PaymentInfo |
paymentRefs | Reference[] |
payments | Payment[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4232 (opens new window)
# PaymentMethodInfo
# Type declaration:
Name | Type |
---|---|
__typename ? | PaymentMethodInfo |
method ? | Maybe<Scalars[String]> |
name ? | Maybe<Scalars[String]> |
nameAllLocales ? | Maybe<LocalizedString[]> |
paymentInterface ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4238 (opens new window)
# PaymentMethodInfoNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4246 (opens new window)
# PaymentQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | PaymentQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Payment[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4251 (opens new window)
# PaymentStatus
# Type declaration:
Name | Type |
---|---|
__typename ? | PaymentStatus |
interfaceCode ? | Maybe<Scalars[String]> |
interfaceText ? | Maybe<Scalars[String]> |
state ? | Maybe<State> |
stateRef ? | Maybe<Reference> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4267 (opens new window)
# PlainEnumValue
# Type declaration:
Name | Type |
---|---|
__typename ? | PlainEnumValue |
key | Scalars[String] |
label | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4275 (opens new window)
# PlainEnumValueDraft
# Type declaration:
Name | Type |
---|---|
key | Scalars[String] |
label | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4281 (opens new window)
# PlainEnumValueResult
# Type declaration:
Name | Type |
---|---|
__typename ? | PlainEnumValueResult |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
results | PlainEnumValue[] |
total | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4286 (opens new window)
# Point
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4294 (opens new window)
# PriceFunction
# Type declaration:
Name | Type |
---|---|
__typename ? | PriceFunction |
currencyCode | Scalars[Currency] |
function | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4300 (opens new window)
# PriceFunctionDraft
# Type declaration:
Name | Type |
---|---|
currencyCode | Scalars[Currency] |
function | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4306 (opens new window)
# Product
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4311 (opens new window)
# ProductAttributeInput
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4335 (opens new window)
# ProductCatalogData
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductCatalogData |
current ? | Maybe<ProductData> |
hasStagedChanges | Scalars[Boolean] |
published | Scalars[Boolean] |
staged ? | Maybe<ProductData> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4340 (opens new window)
# ProductCatalogDataArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4331 (opens new window)
# ProductData
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductData |
allVariants | ProductVariant[] |
categories | Category[] |
categoriesRef | Reference[] |
categoryOrderHint ? | Maybe<Scalars[String]> |
categoryOrderHints | CategoryOrderHint[] |
description ? | Maybe<Scalars[String]> |
descriptionAllLocales ? | Maybe<LocalizedString[]> |
masterVariant | ProductVariant |
metaDescription ? | Maybe<Scalars[String]> |
metaKeywords ? | Maybe<Scalars[String]> |
metaTitle ? | Maybe<Scalars[String]> |
name ? | Maybe<Scalars[String]> |
nameAllLocales | LocalizedString[] |
searchKeyword ? | Maybe<SearchKeyword[]> |
searchKeywords | SearchKeywords[] |
skus | Scalars[String][] |
slug ? | Maybe<Scalars[String]> |
variant ? | Maybe<ProductVariant> |
variants | ProductVariant[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4348 (opens new window)
# ProductDataAllVariantsArgs
# Type declaration:
Name | Type |
---|---|
hasImages ? | Maybe<Scalars[Boolean]> |
isOnStock ? | Maybe<Scalars[Boolean]> |
skus ? | Maybe<Scalars[String][]> |
stockChannelIds ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4416 (opens new window)
# ProductDataCategoryOrderHintArgs
# Type declaration:
Name | Type |
---|---|
categoryId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4386 (opens new window)
# ProductDataDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4376 (opens new window)
# ProductDataMetaDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4404 (opens new window)
# ProductDataMetaKeywordsArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4399 (opens new window)
# ProductDataMetaTitleArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4394 (opens new window)
# ProductDataNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4371 (opens new window)
# ProductDataSearchKeywordArgs
# Type declaration:
Name | Type |
---|---|
locale | Scalars[Locale] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4390 (opens new window)
# ProductDataSlugArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4381 (opens new window)
# ProductDataVariantArgs
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
sku ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4423 (opens new window)
# ProductDataVariantsArgs
# Type declaration:
Name | Type |
---|---|
hasImages ? | Maybe<Scalars[Boolean]> |
isOnStock ? | Maybe<Scalars[Boolean]> |
skus ? | Maybe<Scalars[String][]> |
stockChannelIds ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4409 (opens new window)
# ProductDiscount
A product price can be discounted in two ways:
- with a relative or an absolute product discount, which will be automatically applied to all prices in a product that match a discount predicate. A relative discount reduces the matching price by a fraction (for example 10 % off). An absolute discount reduces the matching price by a fixed amount (for example 10€ off). If more than one product discount matches a price, the discount sort order determines which one will be applied.
- with an external product discount, which can then be used to explicitly set a discounted value on a particular product price.
The discounted price is stored in the discounted field of the Product Price.
Note that when a discount is created, updated or removed it can take up to 15 minutes to update all the prices with the discounts.
The maximum number of ProductDiscounts that can be active at the same time is 200.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4446 (opens new window)
# ProductDiscountDescriptionArgs
A product price can be discounted in two ways:
- with a relative or an absolute product discount, which will be automatically applied to all prices in a product that match a discount predicate. A relative discount reduces the matching price by a fraction (for example 10 % off). An absolute discount reduces the matching price by a fixed amount (for example 10€ off). If more than one product discount matches a price, the discount sort order determines which one will be applied.
- with an external product discount, which can then be used to explicitly set a discounted value on a particular product price.
The discounted price is stored in the discounted field of the Product Price.
Note that when a discount is created, updated or removed it can take up to 15 minutes to update all the prices with the discounts.
The maximum number of ProductDiscounts that can be active at the same time is 200.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4509 (opens new window)
# ProductDiscountDraft
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
isActive ? | Maybe<Scalars[Boolean]> |
key ? | Maybe<Scalars[String]> |
name | LocalizedStringItemInputType[] |
predicate | Scalars[String] |
sortOrder | Scalars[String] |
validFrom ? | Maybe<Scalars[DateTime]> |
validUntil ? | Maybe<Scalars[DateTime]> |
value | ProductDiscountValueInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4514 (opens new window)
# ProductDiscountNameArgs
A product price can be discounted in two ways:
- with a relative or an absolute product discount, which will be automatically applied to all prices in a product that match a discount predicate. A relative discount reduces the matching price by a fraction (for example 10 % off). An absolute discount reduces the matching price by a fixed amount (for example 10€ off). If more than one product discount matches a price, the discount sort order determines which one will be applied.
- with an external product discount, which can then be used to explicitly set a discounted value on a particular product price.
The discounted price is stored in the discounted field of the Product Price.
Note that when a discount is created, updated or removed it can take up to 15 minutes to update all the prices with the discounts.
The maximum number of ProductDiscounts that can be active at the same time is 200.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4486 (opens new window)
# ProductDiscountQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductDiscountQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | ProductDiscount[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4526 (opens new window)
# ProductDiscountUpdateAction
# Type declaration:
Name | Type |
---|---|
changeIsActive ? | Maybe<ChangeProductDiscountIsActive> |
changeName ? | Maybe<ChangeProductDiscountName> |
changePredicate ? | Maybe<ChangeProductDiscountPredicate> |
changeSortOrder ? | Maybe<ChangeProductDiscountSortOrder> |
changeValue ? | Maybe<ChangeProductDiscountValue> |
setDescription ? | Maybe<SetProductDiscountDescription> |
setKey ? | Maybe<SetProductDiscountKey> |
setValidFrom ? | Maybe<SetProductDiscountValidFrom> |
setValidFromAndUntil ? | Maybe<SetProductDiscountValidFromAndUntil> |
setValidUntil ? | Maybe<SetProductDiscountValidUntil> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4534 (opens new window)
# ProductDiscountValue
# Type declaration:
Name | Type |
---|---|
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4547 (opens new window)
# ProductDiscountValueInput
# Type declaration:
Name | Type |
---|---|
absolute ? | Maybe<AbsoluteDiscountValueInput> |
external ? | Maybe<ExternalDiscountValueInput> |
relative ? | Maybe<RelativeDiscountValueInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4551 (opens new window)
# ProductDraft
# Type declaration:
Name | Type |
---|---|
categories ? | Maybe<ResourceIdentifierInput[]> |
categoryOrderHints ? | Maybe<CategoryOrderHintInput[]> |
description ? | Maybe<LocalizedStringItemInputType[]> |
key ? | Maybe<Scalars[String]> |
masterVariant ? | Maybe<ProductVariantInput> |
metaDescription ? | Maybe<LocalizedStringItemInputType[]> |
metaKeywords ? | Maybe<LocalizedStringItemInputType[]> |
metaTitle ? | Maybe<LocalizedStringItemInputType[]> |
name | LocalizedStringItemInputType[] |
productType | ResourceIdentifierInput |
publish ? | Maybe<Scalars[Boolean]> |
searchKeywords ? | Maybe<SearchKeywordInput[]> |
slug | LocalizedStringItemInputType[] |
state ? | Maybe<ResourceIdentifierInput> |
taxCategory ? | Maybe<ResourceIdentifierInput> |
variants ? | Maybe<ProductVariantInput[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4557 (opens new window)
# ProductPrice
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | ProductPrice | - |
channel ? | Maybe<Reference> | - |
country ? | Maybe<Scalars[Country]> | - |
custom ? | Maybe<CustomFieldsType> | - |
customFieldList ? | Maybe<CustomField[]> | Custom fields are returned as a list instead of an object structure. |
customFields ? | Maybe<Type> | This field would contain type data |
customFieldsRaw ? | Maybe<RawCustomField[]> | This field contains non-typed data. Consider using customFields as a typed alternative. |
customerGroup ? | Maybe<Reference> | - |
discounted ? | Maybe<DiscountedProductPriceValue> | - |
id ? | Maybe<Scalars[String]> | - |
tiers ? | Maybe<ProductPriceTier[]> | - |
validFrom ? | Maybe<Scalars[DateTime]> | - |
validUntil ? | Maybe<Scalars[DateTime]> | - |
value | BaseMoney | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4576 (opens new window)
# ProductPriceCustomFieldListArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4601 (opens new window)
# ProductPriceCustomFieldsRawArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4596 (opens new window)
# ProductPriceDataInput
# Type declaration:
Name | Type |
---|---|
channel ? | Maybe<ResourceIdentifierInput> |
country ? | Maybe<Scalars[Country]> |
custom ? | Maybe<CustomFieldsDraft> |
customerGroup ? | Maybe<ReferenceInput> |
tiers ? | Maybe<ProductPriceTierInput[]> |
validFrom ? | Maybe<Scalars[DateTime]> |
validUntil ? | Maybe<Scalars[DateTime]> |
value | BaseMoneyInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4606 (opens new window)
# ProductPriceTier
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductPriceTier |
minimumQuantity | Scalars[Int] |
value | BaseMoney |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4617 (opens new window)
# ProductPriceTierInput
# Type declaration:
Name | Type |
---|---|
minimumQuantity | Scalars[Int] |
value | BaseMoneyInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4623 (opens new window)
# ProductQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Product[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4628 (opens new window)
# ProductReferenceIdentifier
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductReferenceIdentifier |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
typeId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4636 (opens new window)
# ProductType
# Type declaration:
Name | Type |
---|---|
productTypeId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4643 (opens new window)
# ProductTypeDefinition
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4647 (opens new window)
# ProductTypeDefinitionAttributeDefinitionsArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4661 (opens new window)
# ProductTypeDefinitionQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductTypeDefinitionQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | ProductTypeDefinition[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4669 (opens new window)
# ProductTypeDraft
# Type declaration:
Name | Type |
---|---|
attributeDefinitions ? | Maybe<AttributeDefinitionDraft[]> |
description | Scalars[String] |
key ? | Maybe<Scalars[String]> |
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4677 (opens new window)
# ProductTypeUpdateAction
# Type declaration:
Name | Type |
---|---|
addAttributeDefinition ? | Maybe<AddAttributeDefinition> |
addLocalizedEnumValue ? | Maybe<AddLocalizedEnumValue> |
addPlainEnumValue ? | Maybe<AddPlainEnumValue> |
changeAttributeName ? | Maybe<ChangeAttributeName> |
changeAttributeOrder ? | Maybe<ChangeAttributeOrder> |
changeAttributeOrderByName ? | Maybe<ChangeAttributeOrderByName> |
changeDescription ? | Maybe<ChangeDescription> |
changeEnumKey ? | Maybe<ChangeEnumKey> |
changeInputHint ? | Maybe<ChangeInputHint> |
changeIsSearchable ? | Maybe<ChangeIsSearchable> |
changeLabel ? | Maybe<ChangeLabel> |
changeLocalizedEnumValueLabel ? | Maybe<ChangeLocalizedEnumValueLabel> |
changeLocalizedEnumValueOrder ? | Maybe<ChangeLocalizedEnumValueOrder> |
changeName ? | Maybe<ChangeName> |
changePlainEnumValueLabel ? | Maybe<ChangePlainEnumValueLabel> |
changePlainEnumValueOrder ? | Maybe<ChangePlainEnumValueOrder> |
removeAttributeDefinition ? | Maybe<RemoveAttributeDefinition> |
removeEnumValues ? | Maybe<RemoveEnumValues> |
setInputTip ? | Maybe<SetInputTip> |
setKey ? | Maybe<SetKey> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4684 (opens new window)
# ProductUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4707 (opens new window)
# ProductVariant
# Type declaration:
Name | Type | Description |
---|---|---|
__typename ? | ProductVariant | - |
assets | Asset[] | - |
attributeList | Attribute[] | Product attributes are returned as a list instead of an object structure. |
attributes | ProductType | Product attributes |
attributesRaw | RawProductAttribute[] | This field contains non-typed data. Consider using attributes as a typed alternative. |
availability ? | Maybe<ProductVariantAvailabilityWithChannels> | - |
id | Scalars[Int] | - |
images | Image[] | - |
key ? | Maybe<Scalars[String]> | - |
price ? | Maybe<ProductPrice> | Returns a single price based on the price selection rules. |
prices ? | Maybe<ProductPrice[]> | - |
sku ? | Maybe<Scalars[String]> | - |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4757 (opens new window)
# ProductVariantAttributeListArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4789 (opens new window)
# ProductVariantAttributesRawArgs
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4784 (opens new window)
# ProductVariantAvailabilitiesResult
Product variant availabilities
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductVariantAvailabilitiesResult |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
results | ProductVariantAvailabilityWithChannel[] |
total | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4795 (opens new window)
# ProductVariantAvailability
Product variant availability
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductVariantAvailability |
availableQuantity ? | Maybe<Scalars[Long]> |
isOnStock | Scalars[Boolean] |
restockableInDays ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4804 (opens new window)
# ProductVariantAvailabilityWithChannel
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductVariantAvailabilityWithChannel |
availability | ProductVariantAvailability |
channel ? | Maybe<Channel> |
channelRef | Reference |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4811 (opens new window)
# ProductVariantAvailabilityWithChannels
# Type declaration:
Name | Type |
---|---|
__typename ? | ProductVariantAvailabilityWithChannels |
channels | ProductVariantAvailabilitiesResult |
noChannel ? | Maybe<ProductVariantAvailability> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4818 (opens new window)
# ProductVariantAvailabilityWithChannelsChannelsArgs
# Type declaration:
Name | Type |
---|---|
excludeChannelIds ? | Maybe<Scalars[String][]> |
includeChannelIds ? | Maybe<Scalars[String][]> |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4824 (opens new window)
# ProductVariantInput
# Type declaration:
Name | Type |
---|---|
assets ? | Maybe<AssetDraftInput[]> |
attributes ? | Maybe<ProductAttributeInput[]> |
images ? | Maybe<ImageInput[]> |
key ? | Maybe<Scalars[String]> |
prices ? | Maybe<ProductPriceDataInput[]> |
sku ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4831 (opens new window)
# ProductVariantPriceArgs
# Type declaration:
Name | Type |
---|---|
channelId ? | Maybe<Scalars[String]> |
country ? | Maybe<Scalars[Country]> |
currency | Scalars[Currency] |
customerGroupId ? | Maybe<Scalars[String]> |
date ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4776 (opens new window)
# ProjectProjection
Project contains information about project.
# Type declaration:
Name | Type |
---|---|
__typename ? | ProjectProjection |
countries | Scalars[Country][] |
createdAt | Scalars[DateTime] |
currencies | Scalars[Currency][] |
externalOAuth ? | Maybe<ExternalOAuth> |
key | Scalars[String] |
languages | Scalars[Locale][] |
messages | MessagesConfiguration |
name | Scalars[String] |
shippingRateInputType ? | Maybe<ShippingRateInputType> |
trialUntil ? | Maybe<Scalars[YearMonth]> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4841 (opens new window)
# ProjectSettingsUpdateAction
# Type declaration:
Name | Type |
---|---|
changeCountries ? | Maybe<ChangeProjectSettingsCountries> |
changeCurrencies ? | Maybe<ChangeProjectSettingsCurrencies> |
changeLanguages ? | Maybe<ChangeProjectSettingsLanguages> |
changeMessagesConfiguration ? | Maybe<ChangeProjectSettingsMessagesConfiguration> |
changeMessagesEnabled ? | Maybe<ChangeProjectSettingsMessagesEnabled> |
changeName ? | Maybe<ChangeProjectSettingsName> |
setExternalOAuth ? | Maybe<SetProjectSettingsExternalOAuth> |
setShippingRateInputType ? | Maybe<SetProjectSettingsShippingRateInputType> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4856 (opens new window)
# PublishProduct
# Type declaration:
Name | Type |
---|---|
scope ? | Maybe<PublishScope> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4869 (opens new window)
# Query
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4880 (opens new window)
# QueryApiClientArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5231 (opens new window)
# QueryApiClientsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5235 (opens new window)
# QueryCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5168 (opens new window)
# QueryCartDiscountArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5093 (opens new window)
# QueryCartDiscountsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5098 (opens new window)
# QueryCartsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5172 (opens new window)
# QueryCategoriesArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4974 (opens new window)
# QueryCategoryArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4969 (opens new window)
# QueryCategoryAutocompleteArgs
# Type declaration:
Name | Type |
---|---|
experimental ? | Maybe<Scalars[Boolean]> |
filters ? | Maybe<Scalars[SearchFilter][]> |
limit ? | Maybe<Scalars[Int]> |
locale | Scalars[Locale] |
offset ? | Maybe<Scalars[Int]> |
text | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4981 (opens new window)
# QueryCategorySearchArgs
# Type declaration:
Name | Type |
---|---|
experimental ? | Maybe<Scalars[Boolean]> |
filters ? | Maybe<Scalars[SearchFilter][]> |
fulltext ? | Maybe<LocalizedText> |
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
queryFilters ? | Maybe<Scalars[SearchFilter][]> |
sorts ? | Maybe<Scalars[SearchSort][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4990 (opens new window)
# QueryChannelArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5000 (opens new window)
# QueryChannelsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5005 (opens new window)
# QueryCustomerActiveCartArgs
# Type declaration:
Name | Type |
---|---|
customerId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5179 (opens new window)
# QueryCustomerArgs
# Type declaration:
Name | Type |
---|---|
emailToken ? | Maybe<Scalars[String]> |
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
passwordToken ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5143 (opens new window)
# QueryCustomerGroupArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4957 (opens new window)
# QueryCustomerGroupsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4962 (opens new window)
# QueryCustomersArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5150 (opens new window)
# QueryDiscountCodeArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5082 (opens new window)
# QueryDiscountCodesArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5086 (opens new window)
# QueryInStoreArgs
# Type declaration:
Name | Type |
---|---|
key | Scalars[KeyReferenceInput] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4949 (opens new window)
# QueryInStoresArgs
# Type declaration:
Name | Type |
---|---|
keys | Scalars[KeyReferenceInput][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:4953 (opens new window)
# QueryInventoryEntriesArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5161 (opens new window)
# QueryInventoryEntryArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5157 (opens new window)
# QueryOrderArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
orderNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5183 (opens new window)
# QueryOrdersArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5188 (opens new window)
# QueryPaymentArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5207 (opens new window)
# QueryPaymentsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5212 (opens new window)
# QueryProductArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
sku ? | Maybe<Scalars[String]> |
variantKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5116 (opens new window)
# QueryProductDiscountArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5105 (opens new window)
# QueryProductDiscountsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5109 (opens new window)
# QueryProductTypeArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5012 (opens new window)
# QueryProductTypesArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5017 (opens new window)
# QueryProductsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
skus ? | Maybe<Scalars[String][]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5123 (opens new window)
# QueryShippingMethodArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5036 (opens new window)
# QueryShippingMethodsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5041 (opens new window)
# QueryShippingMethodsByCartArgs
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5048 (opens new window)
# QueryShippingMethodsByLocationArgs
# Type declaration:
Name | Type |
---|---|
country | Scalars[Country] |
currency ? | Maybe<Scalars[Currency]> |
state ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5052 (opens new window)
# QueryShoppingListArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5195 (opens new window)
# QueryShoppingListsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5200 (opens new window)
# QueryStateArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5131 (opens new window)
# QueryStatesArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5136 (opens new window)
# QueryStoreArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5219 (opens new window)
# QueryStoresArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5224 (opens new window)
# QueryTaxCategoriesArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5075 (opens new window)
# QueryTaxCategoryArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5070 (opens new window)
# QueryTypeDefinitionArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5024 (opens new window)
# QueryTypeDefinitionsArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5029 (opens new window)
# QueryZoneArgs
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5058 (opens new window)
# QueryZonesArgs
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5063 (opens new window)
# RawCustomField
# Type declaration:
Name | Type |
---|---|
__typename ? | RawCustomField |
name | Scalars[String] |
value | Scalars[Json] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5242 (opens new window)
# RawProductAttribute
# Type declaration:
Name | Type |
---|---|
__typename ? | RawProductAttribute |
attributeDefinition ? | Maybe<AttributeDefinition> |
name | Scalars[String] |
value | Scalars[Json] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5248 (opens new window)
# RecalculateCart
# Type declaration:
Name | Type |
---|---|
updateProductData ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5255 (opens new window)
# Reference
# Type declaration:
Name | Type |
---|---|
__typename ? | Reference |
id | Scalars[String] |
typeId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5259 (opens new window)
# ReferenceAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5265 (opens new window)
# ReferenceAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5272 (opens new window)
# ReferenceField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5278 (opens new window)
# ReferenceInput
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
typeId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5285 (opens new window)
# ReferenceType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5290 (opens new window)
# ReferenceTypeDefinitionDraft
# Type declaration:
Name | Type |
---|---|
referenceTypeId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5296 (opens new window)
# RelativeDiscountValue
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5300 (opens new window)
# RelativeDiscountValueInput
# Type declaration:
Name | Type |
---|---|
permyriad | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5307 (opens new window)
# RemoveAttributeDefinition
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5311 (opens new window)
# RemoveCartCustomLineItem
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5315 (opens new window)
# RemoveCartDiscountCode
# Type declaration:
Name | Type |
---|---|
discountCode | ReferenceInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5319 (opens new window)
# RemoveCartItemShippingAddress
# Type declaration:
Name | Type |
---|---|
addressKey | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5323 (opens new window)
# RemoveCartLineItem
# Type declaration:
Name | Type |
---|---|
externalPrice ? | Maybe<BaseMoneyInput> |
externalTotalPrice ? | Maybe<ExternalLineItemTotalPriceDraft> |
lineItemId | Scalars[String] |
quantity ? | Maybe<Scalars[Long]> |
shippingDetailsToRemove ? | Maybe<ItemShippingDetailsDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5327 (opens new window)
# RemoveCartPayment
# Type declaration:
Name | Type |
---|---|
payment | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5335 (opens new window)
# RemoveCategoryAsset
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5339 (opens new window)
# RemoveCustomerAddress
# Type declaration:
Name | Type |
---|---|
addressId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5344 (opens new window)
# RemoveCustomerBillingAddressId
# Type declaration:
Name | Type |
---|---|
addressId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5348 (opens new window)
# RemoveCustomerShippingAddressId
# Type declaration:
Name | Type |
---|---|
addressId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5352 (opens new window)
# RemoveCustomerStore
# Type declaration:
Name | Type |
---|---|
store | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5356 (opens new window)
# RemoveEnumValues
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
keys | Scalars[String][] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5360 (opens new window)
# RemoveInventoryEntryQuantity
# Type declaration:
Name | Type |
---|---|
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5365 (opens new window)
# RemoveOrderDelivery
# Type declaration:
Name | Type |
---|---|
deliveryId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5369 (opens new window)
# RemoveOrderItemShippingAddress
# Type declaration:
Name | Type |
---|---|
addressKey | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5373 (opens new window)
# RemoveOrderParcelFromDelivery
# Type declaration:
Name | Type |
---|---|
parcelId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5377 (opens new window)
# RemoveOrderPayment
# Type declaration:
Name | Type |
---|---|
payment | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5381 (opens new window)
# RemoveProductAsset
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5385 (opens new window)
# RemoveProductFromCategory
# Type declaration:
Name | Type |
---|---|
category | ResourceIdentifierInput |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5394 (opens new window)
# RemoveProductImage
# Type declaration:
Name | Type |
---|---|
imageUrl | Scalars[String] |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5399 (opens new window)
# RemoveProductPrice
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
price ? | Maybe<ProductPriceDataInput> |
priceId ? | Maybe<Scalars[String]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5406 (opens new window)
# RemoveProductVariant
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[Int]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5415 (opens new window)
# RemoveShippingMethodShippingRate
# Type declaration:
Name | Type |
---|---|
shippingRate | ShippingRateDraft |
zone | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5421 (opens new window)
# RemoveShippingMethodZone
# Type declaration:
Name | Type |
---|---|
zone | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5426 (opens new window)
# RemoveShoppingListLineItem
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
quantity ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5430 (opens new window)
# RemoveShoppingListTextLineItem
# Type declaration:
Name | Type |
---|---|
quantity ? | Maybe<Scalars[Int]> |
textLineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5435 (opens new window)
# RemoveZoneLocation
# Type declaration:
Name | Type |
---|---|
location | ZoneLocation |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5440 (opens new window)
# ReservationOrderType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5444 (opens new window)
# ResourceIdentifierInput
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
typeId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5451 (opens new window)
# ReturnInfo
Stores information about returns connected to this order.
# Type declaration:
Name | Type |
---|---|
__typename ? | ReturnInfo |
items | ReturnItem[] |
returnDate ? | Maybe<Scalars[DateTime]> |
returnTrackingId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5458 (opens new window)
# ReturnItem
# Type declaration:
Name | Type |
---|---|
comment ? | Maybe<Scalars[String]> |
createdAt | Scalars[DateTime] |
id | Scalars[String] |
lastModifiedAt | Scalars[DateTime] |
paymentState | ReturnPaymentState |
quantity | Scalars[Long] |
shipmentState | ReturnShipmentState |
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5465 (opens new window)
# ReturnItemDraftType
# Type declaration:
Name | Type |
---|---|
comment ? | Maybe<Scalars[String]> |
customLineItemId ? | Maybe<Scalars[String]> |
lineItemId ? | Maybe<Scalars[String]> |
quantity | Scalars[Long] |
shipmentState | ReturnShipmentState |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5476 (opens new window)
# RevertStagedChanges
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5498 (opens new window)
# RevertStagedVariantChanges
# Type declaration:
Name | Type |
---|---|
variantId | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5502 (opens new window)
# Scalars
All built-in and custom scalars, mapped to their actual values
# Type declaration:
Name | Type | Description |
---|---|---|
BigDecimal | any | The BigDecimal scalar type represents signed fractional values with arbitrary precision. |
Boolean | boolean | - |
Country | any | ISO 3166-1 (opens new window) country code. |
Currency | any | Represents a currency. Currencies are identified by their ISO 4217 (opens new window) currency codes. |
Date | any | DateTime is a scalar value that represents an ISO8601 formatted date. |
DateTime | any | DateTime is a scalar value that represents an ISO8601 formatted date and time. |
Float | number | - |
ID | string | - |
Int | number | - |
Json | any | Raw JSON value |
KeyReferenceInput | any | A key that references a resource. |
Locale | any | Locale is a scalar value represented as a string language tag. |
Long | any | The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1. |
SearchFilter | any | Search filter. It is represented as a string and has th same format as in REST API: "field:filter_criteria" |
SearchSort | any | Search sort |
String | string | - |
Time | any | Time is a scalar value that represents an ISO8601 formatted time. |
YearMonth | any | YearMonth is a scalar value that represents an ISO8601 formatted year and month. |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5 (opens new window)
# ScoreShippingRateInput
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5519 (opens new window)
# ScoreShippingRateInputDraft
# Type declaration:
Name | Type |
---|---|
score | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5525 (opens new window)
# SearchKeyword
# Type declaration:
Name | Type |
---|---|
__typename ? | SearchKeyword |
text | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5529 (opens new window)
# SearchKeywordInput
# Type declaration:
Name | Type |
---|---|
keywords | CustomSuggestTokenizerInput[] |
locale | Scalars[Locale] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5534 (opens new window)
# SearchKeywords
# Type declaration:
Name | Type |
---|---|
__typename ? | SearchKeywords |
locale | Scalars[Locale] |
searchKeywords | SearchKeyword[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5539 (opens new window)
# SetAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5551 (opens new window)
# SetCartAnonymousId
# Type declaration:
Name | Type |
---|---|
anonymousId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5557 (opens new window)
# SetCartBillingAddress
# Type declaration:
Name | Type |
---|---|
address ? | Maybe<AddressInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5561 (opens new window)
# SetCartCountry
# Type declaration:
Name | Type |
---|---|
country ? | Maybe<Scalars[Country]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5565 (opens new window)
# SetCartCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5581 (opens new window)
# SetCartCustomLineItemCustomField
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5586 (opens new window)
# SetCartCustomLineItemCustomType
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5592 (opens new window)
# SetCartCustomLineItemShippingDetails
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
shippingDetails ? | Maybe<ItemShippingDetailsDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5600 (opens new window)
# SetCartCustomLineItemTaxAmount
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
externalTaxAmount ? | Maybe<ExternalTaxAmountDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5605 (opens new window)
# SetCartCustomLineItemTaxRate
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5610 (opens new window)
# SetCartCustomShippingMethod
# Type declaration:
Name | Type |
---|---|
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
shippingMethodName | Scalars[String] |
shippingRate | ShippingRateDraft |
taxCategory ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5615 (opens new window)
# SetCartCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5622 (opens new window)
# SetCartCustomerEmail
# Type declaration:
Name | Type |
---|---|
email ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5569 (opens new window)
# SetCartCustomerGroup
# Type declaration:
Name | Type |
---|---|
customerGroup ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5573 (opens new window)
# SetCartCustomerId
# Type declaration:
Name | Type |
---|---|
customerId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5577 (opens new window)
# SetCartDeleteDaysAfterLastModification
# Type declaration:
Name | Type |
---|---|
deleteDaysAfterLastModification ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5629 (opens new window)
# SetCartDiscountCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5633 (opens new window)
# SetCartDiscountCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5638 (opens new window)
# SetCartDiscountDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5645 (opens new window)
# SetCartDiscountKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5649 (opens new window)
# SetCartDiscountValidFrom
# Type declaration:
Name | Type |
---|---|
validFrom ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5653 (opens new window)
# SetCartDiscountValidFromAndUntil
# Type declaration:
Name | Type |
---|---|
validFrom ? | Maybe<Scalars[DateTime]> |
validUntil ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5657 (opens new window)
# SetCartDiscountValidUntil
# Type declaration:
Name | Type |
---|---|
validUntil ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5662 (opens new window)
# SetCartLineItemCustomField
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5666 (opens new window)
# SetCartLineItemCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
lineItemId | Scalars[String] |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5672 (opens new window)
# SetCartLineItemPrice
# Type declaration:
Name | Type |
---|---|
externalPrice ? | Maybe<BaseMoneyInput> |
lineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5680 (opens new window)
# SetCartLineItemShippingDetails
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
shippingDetails ? | Maybe<ItemShippingDetailsDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5685 (opens new window)
# SetCartLineItemTaxAmount
# Type declaration:
Name | Type |
---|---|
externalTaxAmount ? | Maybe<ExternalTaxAmountDraft> |
lineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5690 (opens new window)
# SetCartLineItemTaxRate
# Type declaration:
Name | Type |
---|---|
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
lineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5695 (opens new window)
# SetCartLineItemTotalPrice
# Type declaration:
Name | Type |
---|---|
externalTotalPrice ? | Maybe<ExternalLineItemTotalPriceDraft> |
lineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5700 (opens new window)
# SetCartLocale
# Type declaration:
Name | Type |
---|---|
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5705 (opens new window)
# SetCartShippingAddress
# Type declaration:
Name | Type |
---|---|
address ? | Maybe<AddressInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5709 (opens new window)
# SetCartShippingMethod
# Type declaration:
Name | Type |
---|---|
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
shippingMethod ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5713 (opens new window)
# SetCartShippingMethodTaxAmount
# Type declaration:
Name | Type |
---|---|
externalTaxAmount ? | Maybe<ExternalTaxAmountDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5718 (opens new window)
# SetCartShippingMethodTaxRate
# Type declaration:
Name | Type |
---|---|
externalTaxRate ? | Maybe<ExternalTaxRateDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5722 (opens new window)
# SetCartShippingRateInput
# Type declaration:
Name | Type |
---|---|
shippingRateInput ? | Maybe<ShippingRateInputDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5726 (opens new window)
# SetCartTotalTax
# Type declaration:
Name | Type |
---|---|
externalTaxPortions ? | Maybe<TaxPortionDraft[]> |
externalTotalGross ? | Maybe<MoneyInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5730 (opens new window)
# SetCategoryAssetCustomField
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5735 (opens new window)
# SetCategoryAssetCustomType
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5742 (opens new window)
# SetCategoryAssetDescription
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
description ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5751 (opens new window)
# SetCategoryAssetKey
# Type declaration:
Name | Type |
---|---|
assetId | Scalars[String] |
assetKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5757 (opens new window)
# SetCategoryAssetSources
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
sources ? | Maybe<AssetSourceInput[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5762 (opens new window)
# SetCategoryAssetTags
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
tags ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5768 (opens new window)
# SetCategoryCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5774 (opens new window)
# SetCategoryCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5779 (opens new window)
# SetCategoryDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5786 (opens new window)
# SetCategoryExternalId
# Type declaration:
Name | Type |
---|---|
externalId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5790 (opens new window)
# SetCategoryKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5794 (opens new window)
# SetCategoryMetaDescription
# Type declaration:
Name | Type |
---|---|
metaDescription ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5798 (opens new window)
# SetCategoryMetaKeywords
# Type declaration:
Name | Type |
---|---|
metaKeywords ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5802 (opens new window)
# SetCategoryMetaTitle
# Type declaration:
Name | Type |
---|---|
metaTitle ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5806 (opens new window)
# SetCustomerCompanyName
# Type declaration:
Name | Type |
---|---|
companyName ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5810 (opens new window)
# SetCustomerCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5814 (opens new window)
# SetCustomerCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5819 (opens new window)
# SetCustomerDateOfBirth
# Type declaration:
Name | Type |
---|---|
dateOfBirth ? | Maybe<Scalars[Date]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5826 (opens new window)
# SetCustomerDefaultBillingAddress
# Type declaration:
Name | Type |
---|---|
addressId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5830 (opens new window)
# SetCustomerDefaultShippingAddress
# Type declaration:
Name | Type |
---|---|
addressId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5834 (opens new window)
# SetCustomerExternalId
# Type declaration:
Name | Type |
---|---|
externalId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5838 (opens new window)
# SetCustomerFirstName
# Type declaration:
Name | Type |
---|---|
firstName ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5842 (opens new window)
# SetCustomerGroup
# Type declaration:
Name | Type |
---|---|
customerGroup ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5846 (opens new window)
# SetCustomerGroupCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5850 (opens new window)
# SetCustomerGroupCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5855 (opens new window)
# SetCustomerGroupKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5862 (opens new window)
# SetCustomerKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5866 (opens new window)
# SetCustomerLastName
# Type declaration:
Name | Type |
---|---|
lastName ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5870 (opens new window)
# SetCustomerLocale
# Type declaration:
Name | Type |
---|---|
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5874 (opens new window)
# SetCustomerMiddleName
# Type declaration:
Name | Type |
---|---|
middleName ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5878 (opens new window)
# SetCustomerNumber
# Type declaration:
Name | Type |
---|---|
customerNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5882 (opens new window)
# SetCustomerSalutation
# Type declaration:
Name | Type |
---|---|
salutation ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5886 (opens new window)
# SetCustomerStores
# Type declaration:
Name | Type |
---|---|
stores | ResourceIdentifierInput[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5890 (opens new window)
# SetCustomerTitle
# Type declaration:
Name | Type |
---|---|
title ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5894 (opens new window)
# SetCustomerVatId
# Type declaration:
Name | Type |
---|---|
vatId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5898 (opens new window)
# SetDiscountCodeCartPredicate
# Type declaration:
Name | Type |
---|---|
cartPredicate ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5902 (opens new window)
# SetDiscountCodeCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5906 (opens new window)
# SetDiscountCodeCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5911 (opens new window)
# SetDiscountCodeDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5918 (opens new window)
# SetDiscountCodeMaxApplications
# Type declaration:
Name | Type |
---|---|
maxApplications ? | Maybe<Scalars[Long]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5922 (opens new window)
# SetDiscountCodeMaxApplicationsPerCustomer
# Type declaration:
Name | Type |
---|---|
maxApplicationsPerCustomer ? | Maybe<Scalars[Long]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5926 (opens new window)
# SetDiscountCodeName
# Type declaration:
Name | Type |
---|---|
name ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5930 (opens new window)
# SetDiscountCodeValidFrom
# Type declaration:
Name | Type |
---|---|
validFrom ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5934 (opens new window)
# SetDiscountCodeValidFromAndUntil
# Type declaration:
Name | Type |
---|---|
validFrom ? | Maybe<Scalars[DateTime]> |
validUntil ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5938 (opens new window)
# SetDiscountCodeValidUntil
# Type declaration:
Name | Type |
---|---|
validUntil ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5943 (opens new window)
# SetInputTip
# Type declaration:
Name | Type |
---|---|
attributeName | Scalars[String] |
inputTip ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5947 (opens new window)
# SetInventoryEntryCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5952 (opens new window)
# SetInventoryEntryCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5957 (opens new window)
# SetInventoryEntryExpectedDelivery
# Type declaration:
Name | Type |
---|---|
expectedDelivery ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5964 (opens new window)
# SetInventoryEntryRestockableInDays
# Type declaration:
Name | Type |
---|---|
restockableInDays ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5968 (opens new window)
# SetInventoryEntrySupplyChannel
# Type declaration:
Name | Type |
---|---|
supplyChannel ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5972 (opens new window)
# SetKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5976 (opens new window)
# SetMyCartShippingMethod
# Type declaration:
Name | Type |
---|---|
shippingMethod ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5980 (opens new window)
# SetOrderBillingAddress
# Type declaration:
Name | Type |
---|---|
address ? | Maybe<AddressInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5984 (opens new window)
# SetOrderCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5996 (opens new window)
# SetOrderCustomLineItemCustomField
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6001 (opens new window)
# SetOrderCustomLineItemCustomType
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6007 (opens new window)
# SetOrderCustomLineItemShippingDetails
# Type declaration:
Name | Type |
---|---|
customLineItemId | Scalars[String] |
shippingDetails ? | Maybe<ItemShippingDetailsDraftType> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6015 (opens new window)
# SetOrderCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6020 (opens new window)
# SetOrderCustomerEmail
# Type declaration:
Name | Type |
---|---|
email ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5988 (opens new window)
# SetOrderCustomerId
# Type declaration:
Name | Type |
---|---|
customerId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:5992 (opens new window)
# SetOrderDeliveryAddress
# Type declaration:
Name | Type |
---|---|
address ? | Maybe<AddressInput> |
deliveryId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6027 (opens new window)
# SetOrderDeliveryItems
# Type declaration:
Name | Type |
---|---|
deliveryId | Scalars[String] |
items | DeliveryItemDraftType[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6032 (opens new window)
# SetOrderLineItemCustomField
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6037 (opens new window)
# SetOrderLineItemCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
lineItemId | Scalars[String] |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6043 (opens new window)
# SetOrderLineItemShippingDetails
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
shippingDetails ? | Maybe<ItemShippingDetailsDraftType> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6051 (opens new window)
# SetOrderLocale
# Type declaration:
Name | Type |
---|---|
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6056 (opens new window)
# SetOrderNumber
# Type declaration:
Name | Type |
---|---|
orderNumber ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6060 (opens new window)
# SetOrderParcelItems
# Type declaration:
Name | Type |
---|---|
items | DeliveryItemDraftType[] |
parcelId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6064 (opens new window)
# SetOrderParcelMeasurements
# Type declaration:
Name | Type |
---|---|
measurements ? | Maybe<ParcelMeasurementsDraftType> |
parcelId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6069 (opens new window)
# SetOrderParcelTrackingData
# Type declaration:
Name | Type |
---|---|
parcelId | Scalars[String] |
trackingData ? | Maybe<TrackingDataDraftType> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6074 (opens new window)
# SetOrderReturnPaymentState
# Type declaration:
Name | Type |
---|---|
paymentState | ReturnPaymentState |
returnItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6079 (opens new window)
# SetOrderReturnShipmentState
# Type declaration:
Name | Type |
---|---|
returnItemId | Scalars[String] |
shipmentState | ReturnShipmentState |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6084 (opens new window)
# SetOrderShippingAddress
# Type declaration:
Name | Type |
---|---|
address ? | Maybe<AddressInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6089 (opens new window)
# SetProductAssetCustomField
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
name | Scalars[String] |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
value ? | Maybe<Scalars[String]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6093 (opens new window)
# SetProductAssetCustomType
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
fields ? | Maybe<CustomFieldInput[]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6104 (opens new window)
# SetProductAssetDescription
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
description ? | Maybe<LocalizedStringItemInputType[]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6117 (opens new window)
# SetProductAssetKey
# Type declaration:
Name | Type |
---|---|
assetId | Scalars[String] |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6127 (opens new window)
# SetProductAssetSources
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
sku ? | Maybe<Scalars[String]> |
sources ? | Maybe<AssetSourceInput[]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6136 (opens new window)
# SetProductAssetTags
# Type declaration:
Name | Type |
---|---|
assetId ? | Maybe<Scalars[String]> |
assetKey ? | Maybe<Scalars[String]> |
catalog ? | Maybe<ReferenceInput> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
tags ? | Maybe<Scalars[String][]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6146 (opens new window)
# SetProductAttribute
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
value ? | Maybe<Scalars[String]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6156 (opens new window)
# SetProductAttributeInAllVariants
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
staged ? | Maybe<Scalars[Boolean]> |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6164 (opens new window)
# SetProductCategoryOrderHint
# Type declaration:
Name | Type |
---|---|
categoryId | Scalars[String] |
orderHint ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6170 (opens new window)
# SetProductDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6176 (opens new window)
# SetProductDiscountDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6181 (opens new window)
# SetProductDiscountKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6192 (opens new window)
# SetProductDiscountValidFrom
# Type declaration:
Name | Type |
---|---|
validFrom ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6196 (opens new window)
# SetProductDiscountValidFromAndUntil
# Type declaration:
Name | Type |
---|---|
validFrom ? | Maybe<Scalars[DateTime]> |
validUntil ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6200 (opens new window)
# SetProductDiscountValidUntil
# Type declaration:
Name | Type |
---|---|
validUntil ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6205 (opens new window)
# SetProductDiscountedPrice
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
discounted ? | Maybe<DiscountedProductPriceValueInput> |
priceId | Scalars[String] |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6185 (opens new window)
# SetProductImageLabel
# Type declaration:
Name | Type |
---|---|
imageUrl | Scalars[String] |
label ? | Maybe<Scalars[String]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6209 (opens new window)
# SetProductKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6217 (opens new window)
# SetProductMetaAttributes
# Type declaration:
Name | Type |
---|---|
metaDescription ? | Maybe<LocalizedStringItemInputType[]> |
metaKeywords ? | Maybe<LocalizedStringItemInputType[]> |
metaTitle ? | Maybe<LocalizedStringItemInputType[]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6221 (opens new window)
# SetProductMetaDescription
# Type declaration:
Name | Type |
---|---|
metaDescription ? | Maybe<LocalizedStringItemInputType[]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6228 (opens new window)
# SetProductMetaKeywords
# Type declaration:
Name | Type |
---|---|
metaKeywords ? | Maybe<LocalizedStringItemInputType[]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6233 (opens new window)
# SetProductMetaTitle
# Type declaration:
Name | Type |
---|---|
metaTitle ? | Maybe<LocalizedStringItemInputType[]> |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6238 (opens new window)
# SetProductPriceCustomField
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
name | Scalars[String] |
priceId | Scalars[String] |
staged ? | Maybe<Scalars[Boolean]> |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6243 (opens new window)
# SetProductPriceCustomType
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
fields ? | Maybe<CustomFieldInput[]> |
priceId | Scalars[String] |
staged ? | Maybe<Scalars[Boolean]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6251 (opens new window)
# SetProductPrices
# Type declaration:
Name | Type |
---|---|
catalog ? | Maybe<ReferenceInput> |
prices | ProductPriceDataInput[] |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6261 (opens new window)
# SetProductSku
# Type declaration:
Name | Type |
---|---|
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6269 (opens new window)
# SetProductTaxCategory
# Type declaration:
Name | Type |
---|---|
taxCategory ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6275 (opens new window)
# SetProductVariantKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
sku ? | Maybe<Scalars[String]> |
staged ? | Maybe<Scalars[Boolean]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6279 (opens new window)
# SetProjectSettingsExternalOAuth
# Type declaration:
Name | Type |
---|---|
externalOAuth ? | Maybe<ExternalOAuthDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6286 (opens new window)
# SetProjectSettingsShippingRateInputType
# Type declaration:
Name | Type |
---|---|
shippingRateInputType ? | Maybe<ShippingRateInputTypeInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6290 (opens new window)
# SetSearchKeywords
# Type declaration:
Name | Type |
---|---|
searchKeywords | SearchKeywordInput[] |
staged ? | Maybe<Scalars[Boolean]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6294 (opens new window)
# SetShippingMethodDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6299 (opens new window)
# SetShippingMethodKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6303 (opens new window)
# SetShippingMethodPredicate
# Type declaration:
Name | Type |
---|---|
predicate ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6307 (opens new window)
# SetShoppingListAnonymousId
# Type declaration:
Name | Type |
---|---|
anonymousId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6311 (opens new window)
# SetShoppingListCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6319 (opens new window)
# SetShoppingListCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6324 (opens new window)
# SetShoppingListCustomer
# Type declaration:
Name | Type |
---|---|
customer ? | Maybe<ResourceIdentifierInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6315 (opens new window)
# SetShoppingListDeleteDaysAfterLastModification
# Type declaration:
Name | Type |
---|---|
deleteDaysAfterLastModification ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6331 (opens new window)
# SetShoppingListDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6335 (opens new window)
# SetShoppingListKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6339 (opens new window)
# SetShoppingListLineItemCustomField
# Type declaration:
Name | Type |
---|---|
lineItemId | Scalars[String] |
name | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6343 (opens new window)
# SetShoppingListLineItemCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
lineItemId | Scalars[String] |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6349 (opens new window)
# SetShoppingListSlug
# Type declaration:
Name | Type |
---|---|
slug ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6357 (opens new window)
# SetShoppingListTextLineItemCustomField
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
textLineItemId | Scalars[String] |
value ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6361 (opens new window)
# SetShoppingListTextLineItemCustomType
# Type declaration:
Name | Type |
---|---|
fields ? | Maybe<CustomFieldInput[]> |
textLineItemId | Scalars[String] |
type ? | Maybe<ResourceIdentifierInput> |
typeId ? | Maybe<Scalars[String]> |
typeKey ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6367 (opens new window)
# SetShoppingListTextLineItemDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<LocalizedStringItemInputType[]> |
textLineItemId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6375 (opens new window)
# SetStoreLanguages
# Type declaration:
Name | Type |
---|---|
languages ? | Maybe<Scalars[Locale][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6380 (opens new window)
# SetStoreName
# Type declaration:
Name | Type |
---|---|
name ? | Maybe<LocalizedStringItemInputType[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6384 (opens new window)
# SetTaxCategoryKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6388 (opens new window)
# SetType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6392 (opens new window)
# SetZoneDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6398 (opens new window)
# SetZoneKey
# Type declaration:
Name | Type |
---|---|
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6402 (opens new window)
# ShippingInfo
# Type declaration:
Name | Type |
---|---|
__typename ? | ShippingInfo |
deliveries | Delivery[] |
discountedPrice ? | Maybe<DiscountedLineItemPrice> |
price | Money |
shippingMethod ? | Maybe<ShippingMethod> |
shippingMethodName | Scalars[String] |
shippingMethodRef ? | Maybe<Reference> |
shippingMethodState | ShippingMethodState |
shippingRate | ShippingRate |
taxCategory ? | Maybe<Reference> |
taxRate ? | Maybe<TaxRate> |
taxedPrice ? | Maybe<TaxedItemPrice> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6415 (opens new window)
# ShippingMethod
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6430 (opens new window)
# ShippingMethodDraft
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<Scalars[String]> |
isDefault | Scalars[Boolean] |
key ? | Maybe<Scalars[String]> |
name | Scalars[String] |
predicate ? | Maybe<Scalars[String]> |
taxCategory | ResourceIdentifierInput |
zoneRates ? | Maybe<ZoneRateDraft[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6448 (opens new window)
# ShippingMethodQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | ShippingMethodQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | ShippingMethod[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6458 (opens new window)
# ShippingMethodUpdateAction
# Type declaration:
Name | Type |
---|---|
addShippingRate ? | Maybe<AddShippingMethodShippingRate> |
addZone ? | Maybe<AddShippingMethodZone> |
changeIsDefault ? | Maybe<ChangeShippingMethodIsDefault> |
changeName ? | Maybe<ChangeShippingMethodName> |
changeTaxCategory ? | Maybe<ChangeShippingMethodTaxCategory> |
removeShippingRate ? | Maybe<RemoveShippingMethodShippingRate> |
removeZone ? | Maybe<RemoveShippingMethodZone> |
setDescription ? | Maybe<SetShippingMethodDescription> |
setKey ? | Maybe<SetShippingMethodKey> |
setPredicate ? | Maybe<SetShippingMethodPredicate> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6485 (opens new window)
# ShippingMethodsByCartInterface
A field to retrieve available shipping methods for a cart.
# Type declaration:
Name | Type |
---|---|
shippingMethodsByCart | ShippingMethod[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6467 (opens new window)
# ShippingMethodsByCartInterfaceShippingMethodsByCartArgs
A field to retrieve available shipping methods for a cart.
# Type declaration:
Name | Type |
---|---|
id | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6472 (opens new window)
# ShippingRate
Shipping Rate
# Type declaration:
Name | Type |
---|---|
__typename ? | ShippingRate |
freeAbove ? | Maybe<Money> |
isMatching ? | Maybe<Scalars[Boolean]> |
price | Money |
tiers | ShippingRatePriceTier[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6499 (opens new window)
# ShippingRateCartClassificationPriceTier
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6507 (opens new window)
# ShippingRateCartScorePriceTier
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6515 (opens new window)
# ShippingRateCartValuePriceTier
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6524 (opens new window)
# ShippingRateDraft
# Type declaration:
Name | Type |
---|---|
freeAbove ? | Maybe<MoneyDraft> |
price | MoneyDraft |
tiers ? | Maybe<ShippingRatePriceTierDraft[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6532 (opens new window)
# ShippingRateInput
# Type declaration:
Name | Type |
---|---|
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6538 (opens new window)
# ShippingRateInputDraft
# Type declaration:
Name | Type |
---|---|
Classification ? | Maybe<ClassificationShippingRateInputDraft> |
Score ? | Maybe<ScoreShippingRateInputDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6542 (opens new window)
# ShippingRateInputLocalizedEnumValue
# Type declaration:
Name | Type |
---|---|
__typename ? | ShippingRateInputLocalizedEnumValue |
key | Scalars[String] |
label ? | Maybe<Scalars[String]> |
labelAllLocales | LocalizedString[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6547 (opens new window)
# ShippingRateInputLocalizedEnumValueLabelArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6554 (opens new window)
# ShippingRateInputType
# Type declaration:
Name | Type |
---|---|
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6559 (opens new window)
# ShippingRateInputTypeInput
# Type declaration:
Name | Type |
---|---|
CartClassification ? | Maybe<CartClassificationInput> |
CartScore ? | Maybe<CartScoreInput> |
CartValue ? | Maybe<CartValueInput> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6563 (opens new window)
# ShippingRatePriceTier
# Type declaration:
Name | Type |
---|---|
type | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6569 (opens new window)
# ShippingRatePriceTierCartClassificationDraft
# Type declaration:
Name | Type |
---|---|
price | MoneyDraft |
value | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6573 (opens new window)
# ShippingRatePriceTierCartScoreDraft
# Type declaration:
Name | Type |
---|---|
price ? | Maybe<MoneyDraft> |
priceFunction ? | Maybe<PriceFunctionDraft> |
score | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6578 (opens new window)
# ShippingRatePriceTierCartValueDraft
# Type declaration:
Name | Type |
---|---|
minimumCentAmount | Scalars[Int] |
price | MoneyDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6584 (opens new window)
# ShippingRatePriceTierDraft
# Type declaration:
Name | Type |
---|---|
CartClassification ? | Maybe<ShippingRatePriceTierCartClassificationDraft> |
CartScore ? | Maybe<ShippingRatePriceTierCartScoreDraft> |
CartValue ? | Maybe<ShippingRatePriceTierCartValueDraft> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6589 (opens new window)
# ShippingTarget
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6595 (opens new window)
# ShippingTargetDraft
# Type declaration:
Name | Type |
---|---|
addressKey | Scalars[String] |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6600 (opens new window)
# ShippingTargetDraftType
# Type declaration:
Name | Type |
---|---|
addressKey | Scalars[String] |
quantity | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6605 (opens new window)
# ShippingTargetInput
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6610 (opens new window)
# ShoppingList
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6614 (opens new window)
# ShoppingListDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6643 (opens new window)
# ShoppingListDraft
# Type declaration:
Name | Type |
---|---|
anonymousId ? | Maybe<Scalars[String]> |
custom ? | Maybe<CustomFieldsDraft> |
customer ? | Maybe<ResourceIdentifierInput> |
deleteDaysAfterLastModification ? | Maybe<Scalars[Int]> |
description ? | Maybe<LocalizedStringItemInputType[]> |
key ? | Maybe<Scalars[String]> |
lineItems ? | Maybe<ShoppingListLineItemDraft[]> |
name | LocalizedStringItemInputType[] |
slug ? | Maybe<LocalizedStringItemInputType[]> |
textLineItems ? | Maybe<TextLineItemDraft[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6653 (opens new window)
# ShoppingListLineItem
# Type declaration:
Name | Type |
---|---|
__typename ? | ShoppingListLineItem |
addedAt | Scalars[DateTime] |
custom ? | Maybe<CustomFieldsType> |
deactivatedAt ? | Maybe<Scalars[DateTime]> |
id | Scalars[String] |
name ? | Maybe<Scalars[String]> |
nameAllLocales | LocalizedString[] |
productId | Scalars[String] |
productSlug ? | Maybe<Scalars[String]> |
productType | ProductTypeDefinition |
productTypeRef | Reference |
quantity | Scalars[Int] |
variant ? | Maybe<ProductVariant> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6666 (opens new window)
# ShoppingListLineItemDraft
# Type declaration:
Name | Type |
---|---|
addedAt ? | Maybe<Scalars[DateTime]> |
custom ? | Maybe<CustomFieldsDraft> |
productId ? | Maybe<Scalars[String]> |
quantity ? | Maybe<Scalars[Int]> |
sku ? | Maybe<Scalars[String]> |
variantId ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6693 (opens new window)
# ShoppingListLineItemNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6683 (opens new window)
# ShoppingListLineItemProductSlugArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6688 (opens new window)
# ShoppingListNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6638 (opens new window)
# ShoppingListQueryInterface
Fields to access shopping lists. Includes direct access to a single list and searching for shopping lists.
# Type declaration:
Name | Type |
---|---|
shoppingList ? | Maybe<ShoppingList> |
shoppingLists | ShoppingListQueryResult |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6703 (opens new window)
# ShoppingListQueryInterfaceShoppingListArgs
Fields to access shopping lists. Includes direct access to a single list and searching for shopping lists.
# Type declaration:
Name | Type |
---|---|
id ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6709 (opens new window)
# ShoppingListQueryInterfaceShoppingListsArgs
Fields to access shopping lists. Includes direct access to a single list and searching for shopping lists.
# Type declaration:
Name | Type |
---|---|
limit ? | Maybe<Scalars[Int]> |
offset ? | Maybe<Scalars[Int]> |
sort ? | Maybe<Scalars[String][]> |
where ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6715 (opens new window)
# ShoppingListQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | ShoppingListQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | ShoppingList[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6722 (opens new window)
# ShoppingListSlugArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6648 (opens new window)
# ShoppingListUpdateAction
# Type declaration:
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6730 (opens new window)
# SimpleAttributeTypeDraft
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6758 (opens new window)
# StateQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | StateQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | State[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6804 (opens new window)
# Store
[BETA] Stores allow defining different contexts for a project.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6826 (opens new window)
# StoreNameArgs
[BETA] Stores allow defining different contexts for a project.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6841 (opens new window)
# StoreQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | StoreQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Store[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6846 (opens new window)
# StoreUpdateAction
# Type declaration:
Name | Type |
---|---|
setLanguages ? | Maybe<SetStoreLanguages> |
setName ? | Maybe<SetStoreName> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6854 (opens new window)
# StringAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6859 (opens new window)
# StringField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6865 (opens new window)
# StringType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6871 (opens new window)
# SubRate
# Type declaration:
Name | Type |
---|---|
__typename ? | SubRate |
amount | Scalars[Float] |
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6876 (opens new window)
# SubRateDraft
# Type declaration:
Name | Type |
---|---|
amount | Scalars[Float] |
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6882 (opens new window)
# SyncInfo
Stores information about order synchronization activities (like export or import).
# Type declaration:
Name | Type |
---|---|
__typename ? | SyncInfo |
channel ? | Maybe<Channel> |
channelRef | Reference |
externalId ? | Maybe<Scalars[String]> |
syncedAt | Scalars[DateTime] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6890 (opens new window)
# TaxCategory
Tax Categories define how products are to be taxed in different countries.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6910 (opens new window)
# TaxCategoryAddTaxRate
# Type declaration:
Name | Type |
---|---|
taxRate | TaxRateDraft |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6924 (opens new window)
# TaxCategoryChangeName
# Type declaration:
Name | Type |
---|---|
name | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6928 (opens new window)
# TaxCategoryDraft
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<Scalars[String]> |
key ? | Maybe<Scalars[String]> |
name | Scalars[String] |
rates ? | Maybe<TaxRateDraft[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6932 (opens new window)
# TaxCategoryQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | TaxCategoryQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | TaxCategory[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6939 (opens new window)
# TaxCategoryRemoveTaxRate
# Type declaration:
Name | Type |
---|---|
taxRateId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6947 (opens new window)
# TaxCategoryReplaceTaxRate
# Type declaration:
Name | Type |
---|---|
taxRate | TaxRateDraft |
taxRateId | Scalars[String] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6951 (opens new window)
# TaxCategorySetDescription
# Type declaration:
Name | Type |
---|---|
description ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6956 (opens new window)
# TaxCategoryUpdateAction
# Type declaration:
Name | Type |
---|---|
addTaxRate ? | Maybe<TaxCategoryAddTaxRate> |
changeName ? | Maybe<TaxCategoryChangeName> |
removeTaxRate ? | Maybe<TaxCategoryRemoveTaxRate> |
replaceTaxRate ? | Maybe<TaxCategoryReplaceTaxRate> |
setDescription ? | Maybe<TaxCategorySetDescription> |
setKey ? | Maybe<SetTaxCategoryKey> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6960 (opens new window)
# TaxPortion
Represents the portions that sum up to the totalGross field of a TaxedPrice. The portions are calculated from the TaxRates. If a tax rate has SubRates, they are used and can be identified by name. Tax portions from line items that have the same rate and name will be accumulated to the same tax portion.
# Type declaration:
Name | Type |
---|---|
__typename ? | TaxPortion |
amount | Money |
name ? | Maybe<Scalars[String]> |
rate | Scalars[Float] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7006 (opens new window)
# TaxPortionDraft
# Type declaration:
Name | Type |
---|---|
amount | MoneyInput |
name ? | Maybe<Scalars[String]> |
rate | Scalars[Float] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7013 (opens new window)
# TaxRate
# Type declaration:
Name | Type |
---|---|
__typename ? | TaxRate |
amount | Scalars[Float] |
country | Scalars[Country] |
id ? | Maybe<Scalars[String]> |
includedInPrice | Scalars[Boolean] |
name | Scalars[String] |
state ? | Maybe<Scalars[String]> |
subRates | SubRate[] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7019 (opens new window)
# TaxRateDraft
# Type declaration:
Name | Type |
---|---|
amount ? | Maybe<Scalars[Float]> |
country | Scalars[Country] |
includedInPrice | Scalars[Boolean] |
name | Scalars[String] |
state ? | Maybe<Scalars[String]> |
subRates ? | Maybe<SubRateDraft[]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7030 (opens new window)
# TaxedItemPrice
# Type declaration:
Name | Type |
---|---|
__typename ? | TaxedItemPrice |
totalGross | Money |
totalNet | Money |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6969 (opens new window)
# TaxedPrice
# Type declaration:
Name | Type |
---|---|
__typename ? | TaxedPrice |
taxPortions | TaxPortion[] |
totalGross | Money |
totalNet | Money |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:6975 (opens new window)
# TextAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7039 (opens new window)
# TextLineItem
# Type declaration:
Name | Type |
---|---|
__typename ? | TextLineItem |
addedAt | Scalars[DateTime] |
custom ? | Maybe<CustomFieldsType> |
description ? | Maybe<Scalars[String]> |
descriptionAllLocales ? | Maybe<LocalizedString[]> |
id | Scalars[String] |
name ? | Maybe<Scalars[String]> |
nameAllLocales | LocalizedString[] |
quantity | Scalars[Int] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7050 (opens new window)
# TextLineItemDescriptionArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7067 (opens new window)
# TextLineItemDraft
# Type declaration:
Name | Type |
---|---|
addedAt ? | Maybe<Scalars[DateTime]> |
custom ? | Maybe<CustomFieldsDraft> |
description ? | Maybe<LocalizedStringItemInputType[]> |
name | LocalizedStringItemInputType[] |
quantity ? | Maybe<Scalars[Int]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7072 (opens new window)
# TextLineItemNameArgs
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7062 (opens new window)
# TimeAttribute
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7080 (opens new window)
# TimeAttributeDefinitionType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7086 (opens new window)
# TimeField
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7091 (opens new window)
# TimeType
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7097 (opens new window)
# TrackingData
# Type declaration:
Name | Type |
---|---|
__typename ? | TrackingData |
carrier ? | Maybe<Scalars[String]> |
isReturn | Scalars[Boolean] |
provider ? | Maybe<Scalars[String]> |
providerTransaction ? | Maybe<Scalars[String]> |
trackingId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7102 (opens new window)
# TrackingDataDraftType
# Type declaration:
Name | Type |
---|---|
carrier ? | Maybe<Scalars[String]> |
isReturn ? | Maybe<Scalars[Boolean]> |
provider ? | Maybe<Scalars[String]> |
providerTransaction ? | Maybe<Scalars[String]> |
trackingId ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7111 (opens new window)
# Transaction
# Type declaration:
Name | Type |
---|---|
__typename ? | Transaction |
amount | Money |
id | Scalars[String] |
interactionId ? | Maybe<Scalars[String]> |
state | TransactionState |
timestamp ? | Maybe<Scalars[DateTime]> |
type ? | Maybe<TransactionType> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7119 (opens new window)
# TransitionOrderCustomLineItemState
# Type declaration:
Name | Type |
---|---|
actualTransitionDate ? | Maybe<Scalars[DateTime]> |
customLineItemId | Scalars[String] |
fromState | ResourceIdentifierInput |
quantity | Scalars[Long] |
toState | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7144 (opens new window)
# TransitionOrderLineItemState
# Type declaration:
Name | Type |
---|---|
actualTransitionDate ? | Maybe<Scalars[DateTime]> |
fromState | ResourceIdentifierInput |
lineItemId | Scalars[String] |
quantity | Scalars[Long] |
toState | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7152 (opens new window)
# TransitionOrderState
# Type declaration:
Name | Type |
---|---|
force ? | Maybe<Scalars[Boolean]> |
state | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7160 (opens new window)
# TransitionProductState
# Type declaration:
Name | Type |
---|---|
force ? | Maybe<Scalars[Boolean]> |
state | ReferenceInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7165 (opens new window)
# Type
# Type declaration:
Name | Type |
---|---|
type ? | Maybe<TypeDefinition> |
typeRef | Reference |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7170 (opens new window)
# TypeDefinition
Types define the structure of custom fields which can be attached to different entities throughout the platform.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7176 (opens new window)
# TypeDefinitionDescriptionArgs
Types define the structure of custom fields which can be attached to different entities throughout the platform.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7200 (opens new window)
# TypeDefinitionFieldDefinitionsArgs
Types define the structure of custom fields which can be attached to different entities throughout the platform.
# Type declaration:
Name | Type |
---|---|
excludeNames ? | Maybe<Scalars[String][]> |
includeNames ? | Maybe<Scalars[String][]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7206 (opens new window)
# TypeDefinitionNameArgs
Types define the structure of custom fields which can be attached to different entities throughout the platform.
# Type declaration:
Name | Type |
---|---|
acceptLanguage ? | Maybe<Scalars[Locale][]> |
locale ? | Maybe<Scalars[Locale]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7194 (opens new window)
# TypeDefinitionQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | TypeDefinitionQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | TypeDefinition[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7211 (opens new window)
# UnpublishProduct
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7219 (opens new window)
# UpdateCartItemShippingAddress
# Type declaration:
Name | Type |
---|---|
address | AddressInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7223 (opens new window)
# UpdateOrderItemShippingAddress
# Type declaration:
Name | Type |
---|---|
address | AddressInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7227 (opens new window)
# UpdateOrderSyncInfo
# Type declaration:
Name | Type |
---|---|
channel | ResourceIdentifierInput |
externalId ? | Maybe<Scalars[String]> |
syncedAt ? | Maybe<Scalars[DateTime]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7231 (opens new window)
# Versioned
Versioned object have an ID and version and modification. Every update of this object changes it's version.
# Type declaration:
Name | Type |
---|---|
createdAt | Scalars[DateTime] |
createdBy ? | Maybe<Initiator> |
id | Scalars[String] |
lastModifiedAt | Scalars[DateTime] |
lastModifiedBy ? | Maybe<Initiator> |
version | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7238 (opens new window)
# WhitespaceSuggestTokenizerInput
# Type declaration:
Name | Type |
---|---|
dummy ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7247 (opens new window)
# Zone
Zones allow defining ShippingRates for specific Locations.
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7252 (opens new window)
# ZoneLocation
# Type declaration:
Name | Type |
---|---|
country | Scalars[Country] |
state ? | Maybe<Scalars[String]> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7266 (opens new window)
# ZoneQueryResult
# Type declaration:
Name | Type |
---|---|
__typename ? | ZoneQueryResult |
count | Scalars[Int] |
offset | Scalars[Int] |
results | Zone[] |
total | Scalars[Long] |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7271 (opens new window)
# ZoneRate
# Type declaration:
Name | Type |
---|---|
__typename ? | ZoneRate |
shippingRates | ShippingRate[] |
zone ? | Maybe<Zone> |
zoneRef ? | Maybe<Reference> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7279 (opens new window)
# ZoneRateDraft
# Type declaration:
Name | Type |
---|---|
shippingRates ? | Maybe<ShippingRateDraft[]> |
zone | ResourceIdentifierInput |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7286 (opens new window)
# ZoneUpdateAction
# Type declaration:
Name | Type |
---|---|
addLocation ? | Maybe<AddZoneLocation> |
changeName ? | Maybe<ChangeZoneName> |
removeLocation ? | Maybe<RemoveZoneLocation> |
setDescription ? | Maybe<SetZoneDescription> |
setKey ? | Maybe<SetZoneKey> |
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:7291 (opens new window)
# CategoryData
- CategoryData
# categories
Defined in: packages/shopify/api-client/src/api/getCategory/index.ts:9 (opens new window)
# GetMeParams
- GetMeParams
# customer
Defined in: packages/shopify/api-client/src/api/getMe/index.ts:7 (opens new window)
# OrdersData
- OrdersData
# me
Defined in: packages/shopify/api-client/src/api/getMe/index.ts:12 (opens new window)
# ProductData
- ProductData
# products
Defined in: packages/shopify/api-client/src/api/getProduct/index.ts:9 (opens new window)
# UpdateCartParams
- UpdateCartParams
# actions
Defined in: packages/shopify/api-client/src/api/updateCart/index.ts:11 (opens new window)
# id
Defined in: packages/shopify/api-client/src/api/updateCart/index.ts:9 (opens new window)
# version
Defined in: packages/shopify/api-client/src/api/updateCart/index.ts:10 (opens new window)
# versionFallback
Defined in: packages/shopify/api-client/src/api/updateCart/index.ts:12 (opens new window)
# BaseSearch
BaseSearch
# limit
Defined in: packages/shopify/api-client/src/types/Api.ts:29 (opens new window)
# offset
Defined in: packages/shopify/api-client/src/types/Api.ts:30 (opens new window)
# sort
Defined in: packages/shopify/api-client/src/types/Api.ts:31 (opens new window)
# CartData
Omit<CartDraft, currency>
↳ CartData
# anonymousId
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:827 (opens new window)
# billingAddress
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:816 (opens new window)
# country
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:811 (opens new window)
# currency
Defined in: packages/shopify/api-client/src/types/Api.ts:83 (opens new window)
# custom
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:813 (opens new window)
# customLineItems
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:824 (opens new window)
# customerEmail
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:814 (opens new window)
# customerGroup
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:830 (opens new window)
# customerId
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:825 (opens new window)
# deleteDaysAfterLastModification
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:820 (opens new window)
# discountCodes
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:822 (opens new window)
# externalTaxRateForShippingMethod
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:826 (opens new window)
# inventoryMode
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:812 (opens new window)
# itemShippingAddresses
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:821 (opens new window)
# lineItems
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:823 (opens new window)
# locale
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:819 (opens new window)
# origin
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:832 (opens new window)
# shippingAddress
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:815 (opens new window)
# shippingMethod
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:817 (opens new window)
# shippingRateInput
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:831 (opens new window)
# store
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:833 (opens new window)
# taxCalculationMode
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:829 (opens new window)
# taxMode
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:818 (opens new window)
# taxRoundingMode
Defined in: packages/shopify/api-client/src/types/GraphQL.ts:828 (opens new window)
# CategoryWhereSearch
-
↳ CategoryWhereSearch
# catId
Defined in: packages/shopify/api-client/src/types/Api.ts:68 (opens new window)
# limit
Inherited from: BaseSearch.limit
Defined in: packages/shopify/api-client/src/types/Api.ts:29 (opens new window)
# offset
Inherited from: BaseSearch.offset
Defined in: packages/shopify/api-client/src/types/Api.ts:30 (opens new window)
# slug
Defined in: packages/shopify/api-client/src/types/Api.ts:69 (opens new window)
# sort
Inherited from: BaseSearch.sort
Defined in: packages/shopify/api-client/src/types/Api.ts:31 (opens new window)
# Filter
- Filter
# name
Defined in: packages/shopify/api-client/src/types/Api.ts:49 (opens new window)
# type
Defined in: packages/shopify/api-client/src/types/Api.ts:48 (opens new window)
# value
Defined in: packages/shopify/api-client/src/types/Api.ts:50 (opens new window)
# FilterOption
- FilterOption
# label
Defined in: packages/shopify/api-client/src/types/Api.ts:62 (opens new window)
# selected
Defined in: packages/shopify/api-client/src/types/Api.ts:64 (opens new window)
# value
Defined in: packages/shopify/api-client/src/types/Api.ts:63 (opens new window)
# FlowOptions
- FlowOptions
# currentToken
Defined in: packages/shopify/api-client/src/types/Api.ts:77 (opens new window)
# customerCredentials
Defined in: packages/shopify/api-client/src/types/Api.ts:78 (opens new window)
# requireUserSession
Defined in: packages/shopify/api-client/src/types/Api.ts:79 (opens new window)
# OrderWhereSearch
-
↳ OrderWhereSearch
# id
Defined in: packages/shopify/api-client/src/types/Api.ts:73 (opens new window)
# limit
Inherited from: BaseSearch.limit
Defined in: packages/shopify/api-client/src/types/Api.ts:29 (opens new window)
# offset
Inherited from: BaseSearch.offset
Defined in: packages/shopify/api-client/src/types/Api.ts:30 (opens new window)
# sort
Inherited from: BaseSearch.sort
Defined in: packages/shopify/api-client/src/types/Api.ts:31 (opens new window)
# ProductWhereSearch
-
↳ ProductWhereSearch
# catId
Defined in: packages/shopify/api-client/src/types/Api.ts:54 (opens new window)
# filters
Defined in: packages/shopify/api-client/src/types/Api.ts:58 (opens new window)
# id
Defined in: packages/shopify/api-client/src/types/Api.ts:57 (opens new window)
# limit
Inherited from: BaseSearch.limit
Defined in: packages/shopify/api-client/src/types/Api.ts:29 (opens new window)
# offset
Inherited from: BaseSearch.offset
Defined in: packages/shopify/api-client/src/types/Api.ts:30 (opens new window)
# skus
Defined in: packages/shopify/api-client/src/types/Api.ts:55 (opens new window)
# slug
Defined in: packages/shopify/api-client/src/types/Api.ts:56 (opens new window)
# sort
Inherited from: BaseSearch.sort
Defined in: packages/shopify/api-client/src/types/Api.ts:31 (opens new window)
# ClientInstance
ShopifyBuy<any>
↳ ClientInstance
# fetchProducts
Defined in: node_modules/shopify-buy/index.unoptimized.umd.min.js
# fetchSingleProductByID
Defined in: node_modules/shopify-buy/index.unoptimized.umd.min.js:39
# fetchSingleProductByHandle
Defined in: node_modules/shopify-buy/index.unoptimized.umd.min.js:36
# fetchAllCollectonsWithAllProducts
Defined in: node_modules/shopify-buy/index.unoptimized.umd.min.js:32
# fetchCollectonWithProducts
Defined in: node_modules/shopify-buy/index.unoptimized.umd.min.js:38
# InitializeCart
Defined in: node_modules/shopify-buy/index.unoptimized.umd.min.js:35