Docs
GraphQL API
Shop API
Input Objects

Input Objects

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

CollectionFilterParameter

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
position: NumberOperators
description: StringOperators

CollectionListOptions

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

ConfigArgInput

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

ConfigurableOperationInput

code: String!
arguments: [ConfigArgInput!]!

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

CreateCustomerInput

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

CustomerFilterParameter

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

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!

FacetFilterParameter

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

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

HistoryEntryFilterParameter

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

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

id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
orderPlacedAt: DateOperators
code: StringOperators
state: StringOperators
active: BooleanOperators
totalQuantity: NumberOperators
subTotal: NumberOperators
subTotalWithTax: NumberOperators
currencyCode: StringOperators
shipping: NumberOperators
shippingWithTax: NumberOperators
total: NumberOperators
totalWithTax: NumberOperators

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

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

PaymentInput

Passed as input to the addPaymentToOrder mutation.

// This field should correspond to the code property of a PaymentMethod.
method: String!
// This field should contain arbitrary data passed to the specified PaymentMethodHandler’s createPayment() method as the “metadata” argument. For example, it could contain an ID for the payment and other data generated by the payment provider.
metadata: JSON!

ProductFilterParameter

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

ProductSortParameter

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

ProductVariantFilterParameter

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

ProductVariantSortParameter

id: SortOrder
productId: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
sku: SortOrder
name: SortOrder
price: SortOrder
priceWithTax: SortOrder
stockLevel: SortOrder

RegisterCustomerInput

emailAddress: String!
title: String
firstName: String
lastName: String
phoneNumber: String
password: String

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

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

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

UpdateCustomerInput

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

UpdateOrderInput

customFields: JSON

Contents

Community