Skip to main content

Input Objects

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
}

CollectionFilterParameter​

input CollectionFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
position: NumberOperators
description: StringOperators
parentId: IDOperators
_and: [CollectionFilterParameter!]
_or: [CollectionFilterParameter!]
}

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 top-level "filter" fields should be combined 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!]!
}

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
}

CreateCustomerInput​

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

CustomerFilterParameter​

input CustomerFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
title: StringOperators
firstName: StringOperators
lastName: StringOperators
phoneNumber: StringOperators
emailAddress: StringOperators
_and: [CustomerFilterParameter!]
_or: [CustomerFilterParameter!]
}

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 top-level "filter" fields should be combined 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!
}

FacetFilterParameter​

input FacetFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
code: StringOperators
_and: [FacetFilterParameter!]
_or: [FacetFilterParameter!]
}

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 top-level "filter" fields should be combined 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
}

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
facetId: IDOperators
name: StringOperators
code: StringOperators
_and: [FacetValueFilterParameter!]
_or: [FacetValueFilterParameter!]
}

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 top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

FacetValueSortParameter​

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

HistoryEntryFilterParameter​

input HistoryEntryFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
type: StringOperators
_and: [HistoryEntryFilterParameter!]
_or: [HistoryEntryFilterParameter!]
}

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 top-level "filter" fields should be combined 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
}

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{
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
_and: [OrderFilterParameter!]
_or: [OrderFilterParameter!]
}

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 top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

OrderSortParameter​

input 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.
"""
input PaymentInput{
"""
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​

input ProductFilterParameter{
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
description: StringOperators
enabled: BooleanOperators
_and: [ProductFilterParameter!]
_or: [ProductFilterParameter!]
}

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 top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ProductSortParameter​

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

ProductVariantFilterParameter​

input ProductVariantFilterParameter{
id: IDOperators
productId: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
sku: StringOperators
name: StringOperators
price: NumberOperators
currencyCode: StringOperators
priceWithTax: NumberOperators
stockLevel: StringOperators
_and: [ProductVariantFilterParameter!]
_or: [ProductVariantFilterParameter!]
}

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 top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.
"""
filterOperator: LogicalOperator
}

ProductVariantSortParameter​

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

RegisterCustomerInput​

input RegisterCustomerInput{
emailAddress: String!
title: String
firstName: String
lastName: String
phoneNumber: String
password: String
}

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
}

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
}

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
}

UpdateCustomerInput​

input UpdateCustomerInput{
title: String
firstName: String
lastName: String
phoneNumber: String
customFields: JSON
}

UpdateOrderInput​

input UpdateOrderInput{
customFields: JSON
}