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
CollectionFilterParameter
- 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
ConfigArgInput
ConfigurableOperationInput
- code: String!
- arguments: [ConfigArgInput!]!
CreateAddressInput
CreateCustomerInput
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
DateListOperators
Operators for filtering on a list of Date fields
- inList: DateTime!
DateOperators
Operators for filtering on a DateTime field
DateRange
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
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] }] }
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
IDListOperators
Operators for filtering on a list of ID fields
- inList: ID!
IDOperators
Operators for filtering on an ID field
NativeAuthInput
NumberListOperators
Operators for filtering on a list of Number fields
- inList: Float!
NumberOperators
Operators for filtering on a Int or Float field
NumberRange
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
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
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
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
RegisterCustomerInput
SearchInput
- term: String
- facetValueIds: [ID!]
- facetValueOperator: LogicalOperator
- facetValueFilters: [FacetValueFilterInput!]
- collectionId: ID
- collectionSlug: String
- groupByProduct: Boolean
- take: Int
- skip: Int
- sort: SearchResultSortParameter
SearchResultSortParameter
StringListOperators
Operators for filtering on a list of String fields
- inList: String!
StringOperators
Operators for filtering on a String field
UpdateAddressInput
UpdateCustomerInput
UpdateOrderInput
- customFields: JSON