Input Objects

AddItemInput

productVariantId: ID!
quantity: Int!

AddItemToDraftOrderInput

productVariantId: ID!
quantity: Int!

AddNoteToCustomerInput

id: ID!
note: String!
isPublic: Boolean!

AddNoteToOrderInput

id: ID!
note: String!
isPublic: Boolean!

AdjustDraftOrderLineInput

orderLineId: ID!
quantity: Int!

AdministratorFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
firstName: StringOperators
lastName: StringOperators
emailAddress: StringOperators

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

paymentMethod: String
metadata: JSON

AdministratorRefundInput

paymentId: ID!
reason: String

AdministratorSortParameter

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
firstName: SortOrder
lastName: SortOrder
emailAddress: SortOrder

AssetFilterParameter

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

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
fileSize: SortOrder
mimeType: SortOrder
width: SortOrder
height: SortOrder
source: SortOrder
preview: SortOrder

AssignAssetsToChannelInput

assetIds: [ID!]!
channelId: ID!

AssignCollectionsToChannelInput

collectionIds: [ID!]!
channelId: ID!

AssignFacetsToChannelInput

facetIds: [ID!]!
channelId: ID!

AssignPaymentMethodsToChannelInput

paymentMethodIds: [ID!]!
channelId: ID!

AssignProductVariantsToChannelInput

productVariantIds: [ID!]!
channelId: ID!
priceFactor: Float

AssignProductsToChannelInput

productIds: [ID!]!
channelId: ID!
priceFactor: Float

AssignPromotionsToChannelInput

promotionIds: [ID!]!
channelId: ID!

AssignShippingMethodsToChannelInput

shippingMethodIds: [ID!]!
channelId: ID!

AssignStockLocationsToChannelInput

stockLocationIds: [ID!]!
channelId: ID!

AuthenticationInput

native: NativeAuthInput

BooleanListOperators

Operators for filtering on a list of Boolean fields

inList: Boolean!

BooleanOperators

Operators for filtering on a Boolean field

eq: Boolean
isNull: Boolean

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

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

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
token: SortOrder
outOfStockThreshold: SortOrder

CollectionFilterParameter

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

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
slug: SortOrder
position: SortOrder
description: SortOrder
parentId: SortOrder

ConfigArgInput

name: String!
// A JSON stringified representation of the actual value
value: String!

ConfigurableOperationInput

code: String!
arguments: [ConfigArgInput!]!

CoordinateInput

x: Float!
y: Float!

CountryFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
type: StringOperators
name: StringOperators
enabled: BooleanOperators
parentId: IDOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
type: SortOrder
name: SortOrder
parentId: SortOrder

CountryTranslationInput

id: ID
languageCode: LanguageCode!
name: String
customFields: JSON

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

firstName: String!
lastName: String!
emailAddress: String!
password: String!
roleIds: [ID!]!
customFields: JSON

CreateAssetInput

file: Upload!
tags: [String!]
customFields: JSON

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

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

CreateCollectionTranslationInput

languageCode: LanguageCode!
name: String!
slug: String!
description: String!
customFields: JSON

CreateCountryInput

code: String!
translations: [CountryTranslationInput!]!
enabled: Boolean!
customFields: JSON

CreateCustomerGroupInput

name: String!
customerIds: [ID!]
customFields: JSON

CreateCustomerInput

title: String
firstName: String!
lastName: String!
phoneNumber: String
emailAddress: String!
customFields: JSON

CreateFacetInput

code: String!
isPrivate: Boolean!
translations: [FacetTranslationInput!]!
values: [CreateFacetValueWithFacetInput!]
customFields: JSON

CreateFacetValueInput

facetId: ID!
code: String!
translations: [FacetValueTranslationInput!]!
customFields: JSON

CreateFacetValueWithFacetInput

code: String!
translations: [FacetValueTranslationInput!]!

CreateGroupOptionInput

code: String!
translations: [ProductOptionGroupTranslationInput!]!

CreatePaymentMethodInput

code: String!
enabled: Boolean!
checker: ConfigurableOperationInput
handler: ConfigurableOperationInput!
translations: [PaymentMethodTranslationInput!]!
customFields: JSON

CreateProductInput

featuredAssetId: ID
enabled: Boolean
assetIds: [ID!]
facetValueIds: [ID!]
translations: [ProductTranslationInput!]!
customFields: JSON

CreateProductOptionGroupInput

code: String!
translations: [ProductOptionGroupTranslationInput!]!
options: [CreateGroupOptionInput!]!
customFields: JSON

CreateProductOptionInput

productOptionGroupId: ID!
code: String!
translations: [ProductOptionGroupTranslationInput!]!
customFields: JSON

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

optionGroupId: ID!
code: String!
translations: [ProductOptionTranslationInput!]!

CreatePromotionInput

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

CreateProvinceInput

code: String!
translations: [ProvinceTranslationInput!]!
enabled: Boolean!
customFields: JSON

CreateRoleInput

code: String!
description: String!
permissions: [Permission!]!
channelIds: [ID!]

CreateSellerInput

name: String!
customFields: JSON

CreateShippingMethodInput

code: String!
fulfillmentHandler: String!
checker: ConfigurableOperationInput!
calculator: ConfigurableOperationInput!
translations: [ShippingMethodTranslationInput!]!
customFields: JSON

CreateStockLocationInput

name: String!
description: String
customFields: JSON

CreateTagInput

value: String!

CreateTaxCategoryInput

name: String!
isDefault: Boolean
customFields: JSON

CreateTaxRateInput

name: String!
enabled: Boolean!
value: Float!
categoryId: ID!
zoneId: ID!
customerGroupId: ID
customFields: JSON

CreateZoneInput

name: String!
memberIds: [ID!]
customFields: JSON

CustomerFilterParameter

postalCode: StringOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
title: StringOperators
firstName: StringOperators
lastName: StringOperators
phoneNumber: StringOperators
emailAddress: StringOperators

CustomerGroupFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder

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

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

inList: DateTime!

DateOperators

Operators for filtering on a DateTime field

eq: DateTime
before: DateTime
after: DateTime
between: DateRange
isNull: Boolean

DateRange

start: DateTime!
end: DateTime!

DeleteAssetInput

assetId: ID!
force: Boolean
deleteFromAllChannels: Boolean

DeleteAssetsInput

assetIds: [ID!]!
force: Boolean
deleteFromAllChannels: Boolean

DeleteStockLocationInput

id: ID!
transferToLocationId: ID

FacetFilterParameter

isPrivate: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
code: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder

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] }] }

and: ID
or: [ID!]

FacetValueFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
code: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder

FacetValueTranslationInput

id: ID
languageCode: LanguageCode!
name: String
customFields: JSON

FulfillOrderInput

lines: [OrderLineInput!]!
handler: ConfigurableOperationInput!

HistoryEntryFilterParameter

isPublic: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
type: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder

IDListOperators

Operators for filtering on a list of ID fields

inList: ID!

IDOperators

Operators for filtering on an ID field

eq: String
notEq: String
in: [String!]
notIn: [String!]
isNull: Boolean

JobFilterParameter

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

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

id: SortOrder
createdAt: SortOrder
startedAt: SortOrder
settledAt: SortOrder
queueName: SortOrder
progress: SortOrder
duration: SortOrder
retries: SortOrder
attempts: SortOrder

ManualPaymentInput

orderId: ID!
method: String!
transactionId: String
metadata: JSON

MetricSummaryInput

interval: MetricInterval!
types: [MetricType!]!
refresh: Boolean

ModifyOrderInput

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

ModifyOrderOptions

freezePromotions: Boolean
recalculateShipping: Boolean

MoveCollectionInput

collectionId: ID!
parentId: ID!
index: Int!

NativeAuthInput

username: String!
password: String!

NumberListOperators

Operators for filtering on a list of Number fields

inList: Float!

NumberOperators

Operators for filtering on a Int or Float field

eq: Float
lt: Float
lte: Float
gt: Float
gte: Float
between: NumberRange
isNull: Boolean

NumberRange

start: Float!
end: Float!

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

orderLineId: ID!
quantity: Int!

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

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

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
code: StringOperators
description: StringOperators
enabled: BooleanOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder
description: SortOrder

PaymentMethodTranslationInput

id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON

PreviewCollectionVariantsInput

parentId: ID
inheritFilters: Boolean!
filters: [ConfigurableOperationInput!]!

ProductFilterParameter

facetValueId: IDOperators
enabled: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
description: StringOperators

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

id: ID
languageCode: LanguageCode!
name: String
customFields: JSON

ProductOptionTranslationInput

id: ID
languageCode: LanguageCode!
name: String
customFields: JSON

ProductSortParameter

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
slug: SortOrder
description: SortOrder

ProductTranslationInput

id: ID
languageCode: LanguageCode!
name: String
slug: String
description: String
customFields: JSON

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

// 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.

currencyCode: CurrencyCode!
price: Money!
delete: Boolean

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

id: ID
languageCode: LanguageCode!
name: String
customFields: JSON

PromotionFilterParameter

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

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
startsAt: SortOrder
endsAt: SortOrder
couponCode: SortOrder
perCustomerUsageLimit: SortOrder
name: SortOrder
description: SortOrder

PromotionTranslationInput

id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON

ProvinceFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
type: StringOperators
name: StringOperators
enabled: BooleanOperators
parentId: IDOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
type: SortOrder
name: SortOrder
parentId: SortOrder

ProvinceTranslationInput

id: ID
languageCode: LanguageCode!
name: String
customFields: JSON

RefundOrderInput

lines: [OrderLineInput!]!
shipping: Money!
adjustment: Money!
paymentId: ID!
reason: String

RemoveCollectionsFromChannelInput

collectionIds: [ID!]!
channelId: ID!

RemoveFacetsFromChannelInput

facetIds: [ID!]!
channelId: ID!
force: Boolean

RemovePaymentMethodsFromChannelInput

paymentMethodIds: [ID!]!
channelId: ID!

RemoveProductVariantsFromChannelInput

productVariantIds: [ID!]!
channelId: ID!

RemoveProductsFromChannelInput

productIds: [ID!]!
channelId: ID!

RemovePromotionsFromChannelInput

promotionIds: [ID!]!
channelId: ID!

RemoveShippingMethodsFromChannelInput

shippingMethodIds: [ID!]!
channelId: ID!

RemoveStockLocationsFromChannelInput

stockLocationIds: [ID!]!
channelId: ID!

RoleFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
code: StringOperators
description: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
description: SortOrder

SearchInput

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

SearchResultSortParameter

name: SortOrder
price: SortOrder

SellerFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder

SettleRefundInput

id: ID!
transactionId: String!

ShippingMethodFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
name: StringOperators
description: StringOperators
fulfillmentHandlerCode: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
name: SortOrder
description: SortOrder
fulfillmentHandlerCode: SortOrder

ShippingMethodTranslationInput

id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON

StockLevelInput

stockLocationId: ID!
stockOnHand: Int!

StockLocationFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
description: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
description: SortOrder

StockMovementListOptions

type: StockMovementType
skip: Int
take: Int

StringListOperators

Operators for filtering on a list of String fields

inList: String!

StringOperators

Operators for filtering on a String field

eq: String
notEq: String
contains: String
notContains: String
in: [String!]
notIn: [String!]
regex: String
isNull: Boolean

SurchargeInput

description: String!
sku: String
price: Money!
priceIncludesTax: Boolean!
taxRate: Float
taxDescription: String

TagFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
value: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
value: SortOrder

TaxCategoryFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
isDefault: BooleanOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder

TaxRateFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
enabled: BooleanOperators
value: NumberOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
value: SortOrder

TestEligibleShippingMethodsInput

shippingAddress: CreateAddressInput!
lines: [TestShippingMethodOrderLineInput!]!

TestShippingMethodInput

checker: ConfigurableOperationInput!
calculator: ConfigurableOperationInput!
shippingAddress: CreateAddressInput!
lines: [TestShippingMethodOrderLineInput!]!

TestShippingMethodOrderLineInput

productVariantId: ID!
quantity: Int!

UpdateActiveAdministratorInput

firstName: String
lastName: String
emailAddress: String
password: String
customFields: JSON

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

id: ID!
firstName: String
lastName: String
emailAddress: String
password: String
roleIds: [ID!]
customFields: JSON

UpdateAssetInput

id: ID!
name: String
focalPoint: CoordinateInput
tags: [String!]
customFields: JSON

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

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

UpdateCollectionTranslationInput

id: ID
languageCode: LanguageCode!
name: String
slug: String
description: String
customFields: JSON

UpdateCountryInput

id: ID!
code: String
translations: [CountryTranslationInput!]
enabled: Boolean
customFields: JSON

UpdateCustomerGroupInput

id: ID!
name: String
customFields: JSON

UpdateCustomerInput

id: ID!
title: String
firstName: String
lastName: String
phoneNumber: String
emailAddress: String
customFields: JSON

UpdateCustomerNoteInput

noteId: ID!
note: String!

UpdateFacetInput

id: ID!
isPrivate: Boolean
code: String
translations: [FacetTranslationInput!]
customFields: JSON

UpdateFacetValueInput

id: ID!
code: String
translations: [FacetValueTranslationInput!]
customFields: JSON

UpdateGlobalSettingsInput

availableLanguages: [LanguageCode!]
trackInventory: Boolean
outOfStockThreshold: Int
customFields: JSON

UpdateOrderAddressInput

fullName: String
company: String
streetLine1: String
streetLine2: String
city: String
province: String
postalCode: String
countryCode: String
phoneNumber: String

UpdateOrderInput

id: ID!
customFields: JSON

UpdateOrderNoteInput

noteId: ID!
note: String
isPublic: Boolean

UpdatePaymentMethodInput

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

UpdateProductInput

id: ID!
enabled: Boolean
featuredAssetId: ID
assetIds: [ID!]
facetValueIds: [ID!]
translations: [ProductTranslationInput!]
customFields: JSON

UpdateProductOptionGroupInput

id: ID!
code: String
translations: [ProductOptionGroupTranslationInput!]
customFields: JSON

UpdateProductOptionInput

id: ID!
code: String
translations: [ProductOptionGroupTranslationInput!]
customFields: JSON

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

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

UpdateProvinceInput

id: ID!
code: String
translations: [ProvinceTranslationInput!]
enabled: Boolean
customFields: JSON

UpdateRoleInput

id: ID!
code: String
description: String
permissions: [Permission!]
channelIds: [ID!]

UpdateSellerInput

id: ID!
name: String
customFields: JSON

UpdateShippingMethodInput

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

UpdateStockLocationInput

id: ID!
name: String
description: String
customFields: JSON

UpdateTagInput

id: ID!
value: String

UpdateTaxCategoryInput

id: ID!
name: String
isDefault: Boolean
customFields: JSON

UpdateTaxRateInput

id: ID!
name: String
value: Float
enabled: Boolean
categoryId: ID
zoneId: ID
customerGroupId: ID
customFields: JSON

UpdateZoneInput

id: ID!
name: String
customFields: JSON

ZoneFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators

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

id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder

Contents