Skip to main content

Input Objects

AddItemInput​

input AddItemInput{
productVariantId: ID!
quantity: Int!
}

AddItemToDraftOrderInput​

input AddItemToDraftOrderInput{
productVariantId: ID!
quantity: Int!
}

AddNoteToCustomerInput​

input AddNoteToCustomerInput{
id: ID!
note: String!
isPublic: Boolean!
}

AddNoteToOrderInput​

input AddNoteToOrderInput{
id: ID!
note: String!
isPublic: Boolean!
}

AdjustDraftOrderLineInput​

input AdjustDraftOrderLineInput{
orderLineId: ID!
quantity: Int!
}

AdministratorFilterParameter​

input AdministratorFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
firstName: StringOperators
lastName: StringOperators
emailAddress: StringOperators
}

AdministratorListOptions​

input AdministratorListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: AdministratorSortParameter
"""
Allows the results to be filtered
"""
filter: AdministratorFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

AdministratorPaymentInput​

input AdministratorPaymentInput{
paymentMethod: String
metadata: JSON
}

AdministratorRefundInput​

input AdministratorRefundInput{
paymentId: ID!
reason: String
}

AdministratorSortParameter​

input AdministratorSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
firstName: SortOrder
lastName: SortOrder
emailAddress: SortOrder
}

AssetFilterParameter​

input AssetFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
type: StringOperators
fileSize: NumberOperators
mimeType: StringOperators
width: NumberOperators
height: NumberOperators
source: StringOperators
preview: StringOperators
}

AssetListOptions​

input AssetListOptions{
tags: [String!]
tagsOperator: LogicalOperator
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: AssetSortParameter
"""
Allows the results to be filtered
"""
filter: AssetFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

AssetSortParameter​

input AssetSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
fileSize: SortOrder
mimeType: SortOrder
width: SortOrder
height: SortOrder
source: SortOrder
preview: SortOrder
}

AssignAssetsToChannelInput​

input AssignAssetsToChannelInput{
assetIds: [ID!]!
channelId: ID!
}

AssignCollectionsToChannelInput​

input AssignCollectionsToChannelInput{
collectionIds: [ID!]!
channelId: ID!
}

AssignFacetsToChannelInput​

input AssignFacetsToChannelInput{
facetIds: [ID!]!
channelId: ID!
}

AssignPaymentMethodsToChannelInput​

input AssignPaymentMethodsToChannelInput{
paymentMethodIds: [ID!]!
channelId: ID!
}

AssignProductVariantsToChannelInput​

input AssignProductVariantsToChannelInput{
productVariantIds: [ID!]!
channelId: ID!
priceFactor: Float
}

AssignProductsToChannelInput​

input AssignProductsToChannelInput{
productIds: [ID!]!
channelId: ID!
priceFactor: Float
}

AssignPromotionsToChannelInput​

input AssignPromotionsToChannelInput{
promotionIds: [ID!]!
channelId: ID!
}

AssignShippingMethodsToChannelInput​

input AssignShippingMethodsToChannelInput{
shippingMethodIds: [ID!]!
channelId: ID!
}

AssignStockLocationsToChannelInput​

input AssignStockLocationsToChannelInput{
stockLocationIds: [ID!]!
channelId: ID!
}

AuthenticationInput​

input AuthenticationInput{
native: NativeAuthInput
}

BooleanListOperators​

"""
Operators for filtering on a list of Boolean fields
"""
input BooleanListOperators{
inList: Boolean!
}

BooleanOperators​

"""
Operators for filtering on a Boolean field
"""
input BooleanOperators{
eq: Boolean
isNull: Boolean
}

CancelOrderInput​

input CancelOrderInput{
"""
The id of the order to be cancelled
"""
orderId: ID!
"""
Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled
"""
lines: [OrderLineInput!]
"""
Specify whether the shipping charges should also be cancelled. Defaults to false
"""
cancelShipping: Boolean
reason: String
}

ChannelFilterParameter​

input ChannelFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
code: StringOperators
token: StringOperators
defaultLanguageCode: StringOperators
currencyCode: StringOperators
defaultCurrencyCode: StringOperators
trackInventory: BooleanOperators
outOfStockThreshold: NumberOperators
pricesIncludeTax: BooleanOperators
}

ChannelListOptions​

input ChannelListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: ChannelSortParameter
"""
Allows the results to be filtered
"""
filter: ChannelFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ChannelSortParameter​

input ChannelSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
token: SortOrder
outOfStockThreshold: SortOrder
}

CollectionFilterParameter​

input CollectionFilterParameter{
isPrivate: BooleanOperators
inheritFilters: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
position: NumberOperators
description: StringOperators
parentId: IDOperators
}

CollectionListOptions​

input CollectionListOptions{
topLevelOnly: Boolean
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: CollectionSortParameter
"""
Allows the results to be filtered
"""
filter: CollectionFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

CollectionSortParameter​

input CollectionSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
slug: SortOrder
position: SortOrder
description: SortOrder
parentId: SortOrder
}

ConfigArgInput​

input ConfigArgInput{
name: String!
"""
A JSON stringified representation of the actual value
"""
value: String!
}

ConfigurableOperationInput​

input ConfigurableOperationInput{
code: String!
arguments: [ConfigArgInput!]!
}

CoordinateInput​

input CoordinateInput{
x: Float!
y: Float!
}

CountryFilterParameter​

input CountryFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
type: StringOperators
name: StringOperators
enabled: BooleanOperators
parentId: IDOperators
}

CountryListOptions​

input CountryListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: CountrySortParameter
"""
Allows the results to be filtered
"""
filter: CountryFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

CountrySortParameter​

input CountrySortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
type: SortOrder
name: SortOrder
parentId: SortOrder
}

CountryTranslationInput​

input CountryTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}

CreateAddressInput​

input CreateAddressInput{
fullName: String
company: String
streetLine1: String!
streetLine2: String
city: String
province: String
postalCode: String
countryCode: String!
phoneNumber: String
defaultShippingAddress: Boolean
defaultBillingAddress: Boolean
customFields: JSON
}

CreateAdministratorInput​

input CreateAdministratorInput{
firstName: String!
lastName: String!
emailAddress: String!
password: String!
roleIds: [ID!]!
customFields: JSON
}

CreateAssetInput​

input CreateAssetInput{
file: Upload!
tags: [String!]
customFields: JSON
}

CreateChannelInput​

input CreateChannelInput{
code: String!
token: String!
defaultLanguageCode: LanguageCode!
availableLanguageCodes: [LanguageCode!]
pricesIncludeTax: Boolean!
currencyCode: CurrencyCode
defaultCurrencyCode: CurrencyCode
availableCurrencyCodes: [CurrencyCode!]
trackInventory: Boolean
outOfStockThreshold: Int
defaultTaxZoneId: ID!
defaultShippingZoneId: ID!
sellerId: ID
customFields: JSON
}

CreateCollectionInput​

input CreateCollectionInput{
isPrivate: Boolean
featuredAssetId: ID
assetIds: [ID!]
parentId: ID
inheritFilters: Boolean
filters: [ConfigurableOperationInput!]!
translations: [CreateCollectionTranslationInput!]!
customFields: JSON
}

CreateCollectionTranslationInput​

input CreateCollectionTranslationInput{
languageCode: LanguageCode!
name: String!
slug: String!
description: String!
customFields: JSON
}

CreateCountryInput​

input CreateCountryInput{
code: String!
translations: [CountryTranslationInput!]!
enabled: Boolean!
customFields: JSON
}

CreateCustomerGroupInput​

input CreateCustomerGroupInput{
name: String!
customerIds: [ID!]
customFields: JSON
}

CreateCustomerInput​

input CreateCustomerInput{
title: String
firstName: String!
lastName: String!
phoneNumber: String
emailAddress: String!
customFields: JSON
}

CreateFacetInput​

input CreateFacetInput{
code: String!
isPrivate: Boolean!
translations: [FacetTranslationInput!]!
values: [CreateFacetValueWithFacetInput!]
customFields: JSON
}

CreateFacetValueInput​

input CreateFacetValueInput{
facetId: ID!
code: String!
translations: [FacetValueTranslationInput!]!
customFields: JSON
}

CreateFacetValueWithFacetInput​

input CreateFacetValueWithFacetInput{
code: String!
translations: [FacetValueTranslationInput!]!
}

CreateGroupOptionInput​

input CreateGroupOptionInput{
code: String!
translations: [ProductOptionGroupTranslationInput!]!
}

CreatePaymentMethodInput​

input CreatePaymentMethodInput{
code: String!
enabled: Boolean!
checker: ConfigurableOperationInput
handler: ConfigurableOperationInput!
translations: [PaymentMethodTranslationInput!]!
customFields: JSON
}

CreateProductInput​

input CreateProductInput{
featuredAssetId: ID
enabled: Boolean
assetIds: [ID!]
facetValueIds: [ID!]
translations: [ProductTranslationInput!]!
customFields: JSON
}

CreateProductOptionGroupInput​

input CreateProductOptionGroupInput{
code: String!
translations: [ProductOptionGroupTranslationInput!]!
options: [CreateGroupOptionInput!]!
customFields: JSON
}

CreateProductOptionInput​

input CreateProductOptionInput{
productOptionGroupId: ID!
code: String!
translations: [ProductOptionGroupTranslationInput!]!
customFields: JSON
}

CreateProductVariantInput​

input CreateProductVariantInput{
productId: ID!
translations: [ProductVariantTranslationInput!]!
facetValueIds: [ID!]
sku: String!
price: Money
taxCategoryId: ID
optionIds: [ID!]
featuredAssetId: ID
assetIds: [ID!]
stockOnHand: Int
stockLevels: [StockLevelInput!]
outOfStockThreshold: Int
useGlobalOutOfStockThreshold: Boolean
trackInventory: GlobalFlag
customFields: JSON
}

CreateProductVariantOptionInput​

input CreateProductVariantOptionInput{
optionGroupId: ID!
code: String!
translations: [ProductOptionTranslationInput!]!
}

CreatePromotionInput​

input CreatePromotionInput{
enabled: Boolean!
startsAt: DateTime
endsAt: DateTime
couponCode: String
perCustomerUsageLimit: Int
conditions: [ConfigurableOperationInput!]!
actions: [ConfigurableOperationInput!]!
translations: [PromotionTranslationInput!]!
customFields: JSON
}

CreateProvinceInput​

input CreateProvinceInput{
code: String!
translations: [ProvinceTranslationInput!]!
enabled: Boolean!
customFields: JSON
}

CreateRoleInput​

input CreateRoleInput{
code: String!
description: String!
permissions: [Permission!]!
channelIds: [ID!]
}

CreateSellerInput​

input CreateSellerInput{
name: String!
customFields: JSON
}

CreateShippingMethodInput​

input CreateShippingMethodInput{
code: String!
fulfillmentHandler: String!
checker: ConfigurableOperationInput!
calculator: ConfigurableOperationInput!
translations: [ShippingMethodTranslationInput!]!
customFields: JSON
}

CreateStockLocationInput​

input CreateStockLocationInput{
name: String!
description: String
customFields: JSON
}

CreateTagInput​

input CreateTagInput{
value: String!
}

CreateTaxCategoryInput​

input CreateTaxCategoryInput{
name: String!
isDefault: Boolean
customFields: JSON
}

CreateTaxRateInput​

input CreateTaxRateInput{
name: String!
enabled: Boolean!
value: Float!
categoryId: ID!
zoneId: ID!
customerGroupId: ID
customFields: JSON
}

CreateZoneInput​

input CreateZoneInput{
name: String!
memberIds: [ID!]
customFields: JSON
}

CustomerFilterParameter​

input CustomerFilterParameter{
postalCode: StringOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
title: StringOperators
firstName: StringOperators
lastName: StringOperators
phoneNumber: StringOperators
emailAddress: StringOperators
}

CustomerGroupFilterParameter​

input CustomerGroupFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
}

CustomerGroupListOptions​

input CustomerGroupListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: CustomerGroupSortParameter
"""
Allows the results to be filtered
"""
filter: CustomerGroupFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

CustomerGroupSortParameter​

input CustomerGroupSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}

CustomerListOptions​

input CustomerListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: CustomerSortParameter
"""
Allows the results to be filtered
"""
filter: CustomerFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

CustomerSortParameter​

input CustomerSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
title: SortOrder
firstName: SortOrder
lastName: SortOrder
phoneNumber: SortOrder
emailAddress: SortOrder
}

DateListOperators​

"""
Operators for filtering on a list of Date fields
"""
input DateListOperators{
inList: DateTime!
}

DateOperators​

"""
Operators for filtering on a DateTime field
"""
input DateOperators{
eq: DateTime
before: DateTime
after: DateTime
between: DateRange
isNull: Boolean
}

DateRange​

input DateRange{
start: DateTime!
end: DateTime!
}

DeleteAssetInput​

input DeleteAssetInput{
assetId: ID!
force: Boolean
deleteFromAllChannels: Boolean
}

DeleteAssetsInput​

input DeleteAssetsInput{
assetIds: [ID!]!
force: Boolean
deleteFromAllChannels: Boolean
}

DeleteStockLocationInput​

input DeleteStockLocationInput{
id: ID!
transferToLocationId: ID
}

FacetFilterParameter​

input FacetFilterParameter{
isPrivate: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
code: StringOperators
}

FacetListOptions​

input FacetListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: FacetSortParameter
"""
Allows the results to be filtered
"""
filter: FacetFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

FacetSortParameter​

input FacetSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder
}

FacetTranslationInput​

input FacetTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}

FacetValueFilterInput​

"""
Used to construct boolean expressions for filtering search results
by FacetValue ID. Examples:
* ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
* ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
* ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
"""
input FacetValueFilterInput{
and: ID
or: [ID!]
}

FacetValueFilterParameter​

input FacetValueFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
code: StringOperators
}

FacetValueListOptions​

input FacetValueListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: FacetValueSortParameter
"""
Allows the results to be filtered
"""
filter: FacetValueFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

FacetValueSortParameter​

input FacetValueSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder
}

FacetValueTranslationInput​

input FacetValueTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}

FulfillOrderInput​

input FulfillOrderInput{
lines: [OrderLineInput!]!
handler: ConfigurableOperationInput!
}

HistoryEntryFilterParameter​

input HistoryEntryFilterParameter{
isPublic: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
type: StringOperators
}

HistoryEntryListOptions​

input HistoryEntryListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: HistoryEntrySortParameter
"""
Allows the results to be filtered
"""
filter: HistoryEntryFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

HistoryEntrySortParameter​

input HistoryEntrySortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
}

IDListOperators​

"""
Operators for filtering on a list of ID fields
"""
input IDListOperators{
inList: ID!
}

IDOperators​

"""
Operators for filtering on an ID field
"""
input IDOperators{
eq: String
notEq: String
in: [String!]
notIn: [String!]
isNull: Boolean
}

JobFilterParameter​

input JobFilterParameter{
id: IDOperators
createdAt: DateOperators
startedAt: DateOperators
settledAt: DateOperators
queueName: StringOperators
state: StringOperators
progress: NumberOperators
isSettled: BooleanOperators
duration: NumberOperators
retries: NumberOperators
attempts: NumberOperators
}

JobListOptions​

input JobListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: JobSortParameter
"""
Allows the results to be filtered
"""
filter: JobFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

JobSortParameter​

input JobSortParameter{
id: SortOrder
createdAt: SortOrder
startedAt: SortOrder
settledAt: SortOrder
queueName: SortOrder
progress: SortOrder
duration: SortOrder
retries: SortOrder
attempts: SortOrder
}

ManualPaymentInput​

input ManualPaymentInput{
orderId: ID!
method: String!
transactionId: String
metadata: JSON
}

MetricSummaryInput​

input MetricSummaryInput{
interval: MetricInterval!
types: [MetricType!]!
refresh: Boolean
}

ModifyOrderInput​

input ModifyOrderInput{
dryRun: Boolean!
orderId: ID!
addItems: [AddItemInput!]
adjustOrderLines: [OrderLineInput!]
surcharges: [SurchargeInput!]
updateShippingAddress: UpdateOrderAddressInput
updateBillingAddress: UpdateOrderAddressInput
note: String
refund: AdministratorRefundInput
options: ModifyOrderOptions
couponCodes: [String!]
}

ModifyOrderOptions​

input ModifyOrderOptions{
freezePromotions: Boolean
recalculateShipping: Boolean
}

MoveCollectionInput​

input MoveCollectionInput{
collectionId: ID!
parentId: ID!
index: Int!
}

NativeAuthInput​

input NativeAuthInput{
username: String!
password: String!
}

NumberListOperators​

"""
Operators for filtering on a list of Number fields
"""
input NumberListOperators{
inList: Float!
}

NumberOperators​

"""
Operators for filtering on a Int or Float field
"""
input NumberOperators{
eq: Float
lt: Float
lte: Float
gt: Float
gte: Float
between: NumberRange
isNull: Boolean
}

NumberRange​

input NumberRange{
start: Float!
end: Float!
}

OrderFilterParameter​

input OrderFilterParameter{
customerLastName: StringOperators
transactionId: StringOperators
aggregateOrderId: IDOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
type: StringOperators
orderPlacedAt: DateOperators
code: StringOperators
state: StringOperators
active: BooleanOperators
totalQuantity: NumberOperators
subTotal: NumberOperators
subTotalWithTax: NumberOperators
currencyCode: StringOperators
shipping: NumberOperators
shippingWithTax: NumberOperators
total: NumberOperators
totalWithTax: NumberOperators
}

OrderLineInput​

input OrderLineInput{
orderLineId: ID!
quantity: Int!
}

OrderListOptions​

input OrderListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: OrderSortParameter
"""
Allows the results to be filtered
"""
filter: OrderFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

OrderSortParameter​

input OrderSortParameter{
customerLastName: SortOrder
transactionId: SortOrder
aggregateOrderId: SortOrder
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
orderPlacedAt: SortOrder
code: SortOrder
state: SortOrder
totalQuantity: SortOrder
subTotal: SortOrder
subTotalWithTax: SortOrder
shipping: SortOrder
shippingWithTax: SortOrder
total: SortOrder
totalWithTax: SortOrder
}

PaymentMethodFilterParameter​

input PaymentMethodFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
code: StringOperators
description: StringOperators
enabled: BooleanOperators
}

PaymentMethodListOptions​

input PaymentMethodListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: PaymentMethodSortParameter
"""
Allows the results to be filtered
"""
filter: PaymentMethodFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

PaymentMethodSortParameter​

input PaymentMethodSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder
description: SortOrder
}

PaymentMethodTranslationInput​

input PaymentMethodTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON
}

PreviewCollectionVariantsInput​

input PreviewCollectionVariantsInput{
parentId: ID
inheritFilters: Boolean!
filters: [ConfigurableOperationInput!]!
}

ProductFilterParameter​

input ProductFilterParameter{
facetValueId: IDOperators
enabled: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
description: StringOperators
}

ProductListOptions​

input ProductListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: ProductSortParameter
"""
Allows the results to be filtered
"""
filter: ProductFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ProductOptionGroupTranslationInput​

input ProductOptionGroupTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}

ProductOptionTranslationInput​

input ProductOptionTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}

ProductSortParameter​

input ProductSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
slug: SortOrder
description: SortOrder
}

ProductTranslationInput​

input ProductTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
slug: String
description: String
customFields: JSON
}

ProductVariantFilterParameter​

input ProductVariantFilterParameter{
facetValueId: IDOperators
enabled: BooleanOperators
trackInventory: StringOperators
stockOnHand: NumberOperators
stockAllocated: NumberOperators
outOfStockThreshold: NumberOperators
useGlobalOutOfStockThreshold: BooleanOperators
id: IDOperators
productId: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
sku: StringOperators
name: StringOperators
price: NumberOperators
currencyCode: StringOperators
priceWithTax: NumberOperators
stockLevel: StringOperators
}

ProductVariantListOptions​

input ProductVariantListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: ProductVariantSortParameter
"""
Allows the results to be filtered
"""
filter: ProductVariantFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ProductVariantPriceInput​

"""
Used to set up update the price of a ProductVariant in a particular Channel.
If the delete flag is `true`, the price will be deleted for the given Channel.
"""
input ProductVariantPriceInput{
currencyCode: CurrencyCode!
price: Money!
delete: Boolean
}

ProductVariantSortParameter​

input ProductVariantSortParameter{
stockOnHand: SortOrder
stockAllocated: SortOrder
outOfStockThreshold: SortOrder
id: SortOrder
productId: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
sku: SortOrder
name: SortOrder
price: SortOrder
priceWithTax: SortOrder
stockLevel: SortOrder
}

ProductVariantTranslationInput​

input ProductVariantTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}

PromotionFilterParameter​

input PromotionFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
startsAt: DateOperators
endsAt: DateOperators
couponCode: StringOperators
perCustomerUsageLimit: NumberOperators
name: StringOperators
description: StringOperators
enabled: BooleanOperators
}

PromotionListOptions​

input PromotionListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: PromotionSortParameter
"""
Allows the results to be filtered
"""
filter: PromotionFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

PromotionSortParameter​

input PromotionSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
startsAt: SortOrder
endsAt: SortOrder
couponCode: SortOrder
perCustomerUsageLimit: SortOrder
name: SortOrder
description: SortOrder
}

PromotionTranslationInput​

input PromotionTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON
}

ProvinceFilterParameter​

input ProvinceFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
type: StringOperators
name: StringOperators
enabled: BooleanOperators
parentId: IDOperators
}

ProvinceListOptions​

input ProvinceListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: ProvinceSortParameter
"""
Allows the results to be filtered
"""
filter: ProvinceFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ProvinceSortParameter​

input ProvinceSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
type: SortOrder
name: SortOrder
parentId: SortOrder
}

ProvinceTranslationInput​

input ProvinceTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}

RefundOrderInput​

input RefundOrderInput{
lines: [OrderLineInput!]!
shipping: Money!
adjustment: Money!
paymentId: ID!
reason: String
}

RemoveCollectionsFromChannelInput​

input RemoveCollectionsFromChannelInput{
collectionIds: [ID!]!
channelId: ID!
}

RemoveFacetsFromChannelInput​

input RemoveFacetsFromChannelInput{
facetIds: [ID!]!
channelId: ID!
force: Boolean
}

RemovePaymentMethodsFromChannelInput​

input RemovePaymentMethodsFromChannelInput{
paymentMethodIds: [ID!]!
channelId: ID!
}

RemoveProductVariantsFromChannelInput​

input RemoveProductVariantsFromChannelInput{
productVariantIds: [ID!]!
channelId: ID!
}

RemoveProductsFromChannelInput​

input RemoveProductsFromChannelInput{
productIds: [ID!]!
channelId: ID!
}

RemovePromotionsFromChannelInput​

input RemovePromotionsFromChannelInput{
promotionIds: [ID!]!
channelId: ID!
}

RemoveShippingMethodsFromChannelInput​

input RemoveShippingMethodsFromChannelInput{
shippingMethodIds: [ID!]!
channelId: ID!
}

RemoveStockLocationsFromChannelInput​

input RemoveStockLocationsFromChannelInput{
stockLocationIds: [ID!]!
channelId: ID!
}

RoleFilterParameter​

input RoleFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
code: StringOperators
description: StringOperators
}

RoleListOptions​

input RoleListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: RoleSortParameter
"""
Allows the results to be filtered
"""
filter: RoleFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

RoleSortParameter​

input RoleSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
description: SortOrder
}

SearchInput​

input SearchInput{
term: String
facetValueIds: [ID!]
facetValueOperator: LogicalOperator
facetValueFilters: [FacetValueFilterInput!]
collectionId: ID
collectionSlug: String
groupByProduct: Boolean
take: Int
skip: Int
sort: SearchResultSortParameter
}

SearchResultSortParameter​

input SearchResultSortParameter{
name: SortOrder
price: SortOrder
}

SellerFilterParameter​

input SellerFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
}

SellerListOptions​

input SellerListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: SellerSortParameter
"""
Allows the results to be filtered
"""
filter: SellerFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

SellerSortParameter​

input SellerSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}

SettleRefundInput​

input SettleRefundInput{
id: ID!
transactionId: String!
}

ShippingMethodFilterParameter​

input ShippingMethodFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
name: StringOperators
description: StringOperators
fulfillmentHandlerCode: StringOperators
}

ShippingMethodListOptions​

input ShippingMethodListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: ShippingMethodSortParameter
"""
Allows the results to be filtered
"""
filter: ShippingMethodFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ShippingMethodSortParameter​

input ShippingMethodSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
name: SortOrder
description: SortOrder
fulfillmentHandlerCode: SortOrder
}

ShippingMethodTranslationInput​

input ShippingMethodTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON
}

StockLevelInput​

input StockLevelInput{
stockLocationId: ID!
stockOnHand: Int!
}

StockLocationFilterParameter​

input StockLocationFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
description: StringOperators
}

StockLocationListOptions​

input StockLocationListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: StockLocationSortParameter
"""
Allows the results to be filtered
"""
filter: StockLocationFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

StockLocationSortParameter​

input StockLocationSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
description: SortOrder
}

StockMovementListOptions​

input StockMovementListOptions{
type: StockMovementType
skip: Int
take: Int
}

StringListOperators​

"""
Operators for filtering on a list of String fields
"""
input StringListOperators{
inList: String!
}

StringOperators​

"""
Operators for filtering on a String field
"""
input StringOperators{
eq: String
notEq: String
contains: String
notContains: String
in: [String!]
notIn: [String!]
regex: String
isNull: Boolean
}

SurchargeInput​

input SurchargeInput{
description: String!
sku: String
price: Money!
priceIncludesTax: Boolean!
taxRate: Float
taxDescription: String
}

TagFilterParameter​

input TagFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
value: StringOperators
}

TagListOptions​

input TagListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: TagSortParameter
"""
Allows the results to be filtered
"""
filter: TagFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

TagSortParameter​

input TagSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
value: SortOrder
}

TaxCategoryFilterParameter​

input TaxCategoryFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
isDefault: BooleanOperators
}

TaxCategoryListOptions​

input TaxCategoryListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: TaxCategorySortParameter
"""
Allows the results to be filtered
"""
filter: TaxCategoryFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

TaxCategorySortParameter​

input TaxCategorySortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}

TaxRateFilterParameter​

input TaxRateFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
enabled: BooleanOperators
value: NumberOperators
}

TaxRateListOptions​

input TaxRateListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: TaxRateSortParameter
"""
Allows the results to be filtered
"""
filter: TaxRateFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

TaxRateSortParameter​

input TaxRateSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
value: SortOrder
}

TestEligibleShippingMethodsInput​

input TestEligibleShippingMethodsInput{
shippingAddress: CreateAddressInput!
lines: [TestShippingMethodOrderLineInput!]!
}

TestShippingMethodInput​

input TestShippingMethodInput{
checker: ConfigurableOperationInput!
calculator: ConfigurableOperationInput!
shippingAddress: CreateAddressInput!
lines: [TestShippingMethodOrderLineInput!]!
}

TestShippingMethodOrderLineInput​

input TestShippingMethodOrderLineInput{
productVariantId: ID!
quantity: Int!
}

UpdateActiveAdministratorInput​

input UpdateActiveAdministratorInput{
firstName: String
lastName: String
emailAddress: String
password: String
customFields: JSON
}

UpdateAddressInput​

input UpdateAddressInput{
id: ID!
fullName: String
company: String
streetLine1: String
streetLine2: String
city: String
province: String
postalCode: String
countryCode: String
phoneNumber: String
defaultShippingAddress: Boolean
defaultBillingAddress: Boolean
customFields: JSON
}

UpdateAdministratorInput​

input UpdateAdministratorInput{
id: ID!
firstName: String
lastName: String
emailAddress: String
password: String
roleIds: [ID!]
customFields: JSON
}

UpdateAssetInput​

input UpdateAssetInput{
id: ID!
name: String
focalPoint: CoordinateInput
tags: [String!]
customFields: JSON
}

UpdateChannelInput​

input UpdateChannelInput{
id: ID!
code: String
token: String
defaultLanguageCode: LanguageCode
availableLanguageCodes: [LanguageCode!]
pricesIncludeTax: Boolean
currencyCode: CurrencyCode
defaultCurrencyCode: CurrencyCode
availableCurrencyCodes: [CurrencyCode!]
trackInventory: Boolean
outOfStockThreshold: Int
defaultTaxZoneId: ID
defaultShippingZoneId: ID
sellerId: ID
customFields: JSON
}

UpdateCollectionInput​

input UpdateCollectionInput{
id: ID!
isPrivate: Boolean
featuredAssetId: ID
parentId: ID
assetIds: [ID!]
inheritFilters: Boolean
filters: [ConfigurableOperationInput!]
translations: [UpdateCollectionTranslationInput!]
customFields: JSON
}

UpdateCollectionTranslationInput​

input UpdateCollectionTranslationInput{
id: ID
languageCode: LanguageCode!
name: String
slug: String
description: String
customFields: JSON
}

UpdateCountryInput​

input UpdateCountryInput{
id: ID!
code: String
translations: [CountryTranslationInput!]
enabled: Boolean
customFields: JSON
}

UpdateCustomerGroupInput​

input UpdateCustomerGroupInput{
id: ID!
name: String
customFields: JSON
}

UpdateCustomerInput​

input UpdateCustomerInput{
id: ID!
title: String
firstName: String
lastName: String
phoneNumber: String
emailAddress: String
customFields: JSON
}

UpdateCustomerNoteInput​

input UpdateCustomerNoteInput{
noteId: ID!
note: String!
}

UpdateFacetInput​

input UpdateFacetInput{
id: ID!
isPrivate: Boolean
code: String
translations: [FacetTranslationInput!]
customFields: JSON
}

UpdateFacetValueInput​

input UpdateFacetValueInput{
id: ID!
code: String
translations: [FacetValueTranslationInput!]
customFields: JSON
}

UpdateGlobalSettingsInput​

input UpdateGlobalSettingsInput{
availableLanguages: [LanguageCode!]
trackInventory: Boolean
outOfStockThreshold: Int
customFields: JSON
}

UpdateOrderAddressInput​

input UpdateOrderAddressInput{
fullName: String
company: String
streetLine1: String
streetLine2: String
city: String
province: String
postalCode: String
countryCode: String
phoneNumber: String
}

UpdateOrderInput​

input UpdateOrderInput{
id: ID!
customFields: JSON
}

UpdateOrderNoteInput​

input UpdateOrderNoteInput{
noteId: ID!
note: String
isPublic: Boolean
}

UpdatePaymentMethodInput​

input UpdatePaymentMethodInput{
id: ID!
code: String
enabled: Boolean
checker: ConfigurableOperationInput
handler: ConfigurableOperationInput
translations: [PaymentMethodTranslationInput!]
customFields: JSON
}

UpdateProductInput​

input UpdateProductInput{
id: ID!
enabled: Boolean
featuredAssetId: ID
assetIds: [ID!]
facetValueIds: [ID!]
translations: [ProductTranslationInput!]
customFields: JSON
}

UpdateProductOptionGroupInput​

input UpdateProductOptionGroupInput{
id: ID!
code: String
translations: [ProductOptionGroupTranslationInput!]
customFields: JSON
}

UpdateProductOptionInput​

input UpdateProductOptionInput{
id: ID!
code: String
translations: [ProductOptionGroupTranslationInput!]
customFields: JSON
}

UpdateProductVariantInput​

input UpdateProductVariantInput{
id: ID!
enabled: Boolean
translations: [ProductVariantTranslationInput!]
facetValueIds: [ID!]
optionIds: [ID!]
sku: String
taxCategoryId: ID
"""
Sets the price for the ProductVariant in the Channel's default currency
"""
price: Money
"""
Allows multiple prices to be set for the ProductVariant in different currencies.
"""
prices: [ProductVariantPriceInput!]
featuredAssetId: ID
assetIds: [ID!]
stockOnHand: Int
stockLevels: [StockLevelInput!]
outOfStockThreshold: Int
useGlobalOutOfStockThreshold: Boolean
trackInventory: GlobalFlag
customFields: JSON
}

UpdatePromotionInput​

input UpdatePromotionInput{
id: ID!
enabled: Boolean
startsAt: DateTime
endsAt: DateTime
couponCode: String
perCustomerUsageLimit: Int
conditions: [ConfigurableOperationInput!]
actions: [ConfigurableOperationInput!]
translations: [PromotionTranslationInput!]
customFields: JSON
}

UpdateProvinceInput​

input UpdateProvinceInput{
id: ID!
code: String
translations: [ProvinceTranslationInput!]
enabled: Boolean
customFields: JSON
}

UpdateRoleInput​

input UpdateRoleInput{
id: ID!
code: String
description: String
permissions: [Permission!]
channelIds: [ID!]
}

UpdateSellerInput​

input UpdateSellerInput{
id: ID!
name: String
customFields: JSON
}

UpdateShippingMethodInput​

input UpdateShippingMethodInput{
id: ID!
code: String
fulfillmentHandler: String
checker: ConfigurableOperationInput
calculator: ConfigurableOperationInput
translations: [ShippingMethodTranslationInput!]!
customFields: JSON
}

UpdateStockLocationInput​

input UpdateStockLocationInput{
id: ID!
name: String
description: String
customFields: JSON
}

UpdateTagInput​

input UpdateTagInput{
id: ID!
value: String
}

UpdateTaxCategoryInput​

input UpdateTaxCategoryInput{
id: ID!
name: String
isDefault: Boolean
customFields: JSON
}

UpdateTaxRateInput​

input UpdateTaxRateInput{
id: ID!
name: String
value: Float
enabled: Boolean
categoryId: ID
zoneId: ID
customerGroupId: ID
customFields: JSON
}

UpdateZoneInput​

input UpdateZoneInput{
id: ID!
name: String
customFields: JSON
}

ZoneFilterParameter​

input ZoneFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
}

ZoneListOptions​

input ZoneListOptions{
"""
Skips the first n results, for use in pagination
"""
skip: Int
"""
Takes n results, for use in pagination
"""
take: Int
"""
Specifies which properties to sort the results by
"""
sort: ZoneSortParameter
"""
Allows the results to be filtered
"""
filter: ZoneFilterParameter
"""
Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ZoneSortParameter​

input ZoneSortParameter{
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}