Queries
activeAdministrator
- activeAdministrator: Administrator
activeChannel
- activeChannel: Channel!
administrator
- administrator(id: ID!): Administrator
administrators
- administrators(options: AdministratorListOptions): AdministratorList!
asset
Get a single Asset by id
assets
Get a list of Assets
- assets(options: AssetListOptions): AssetList!
channel
channels
- channels: [Channel!]!
collection
Get a Collection either by id or slug. If neither id nor slug is specified, an error will result.
- collection(id: ID, slug: String): Collection
collectionFilters
- collectionFilters: [ConfigurableOperationDefinition!]!
collections
- collections(options: CollectionListOptions): CollectionList!
countries
- countries(options: CountryListOptions): CountryList!
country
customer
customerGroup
- customerGroup(id: ID!): CustomerGroup
customerGroups
- customerGroups(options: CustomerGroupListOptions): CustomerGroupList!
customers
- customers(options: CustomerListOptions): CustomerList!
eligibleShippingMethodsForDraftOrder
Returns a list of eligible shipping methods for the draft Order
- eligibleShippingMethodsForDraftOrder(orderId: ID!): [ShippingMethodQuote!]!
facet
facetValues
- facetValues(options: FacetValueListOptions): FacetValueList!
facets
- facets(options: FacetListOptions): FacetList!
fulfillmentHandlers
- fulfillmentHandlers: [ConfigurableOperationDefinition!]!
globalSettings
- globalSettings: GlobalSettings!
job
jobBufferSize
- jobBufferSize(bufferIds: [String!]): [JobBufferSize!]!
jobQueues
- jobQueues: [JobQueue!]!
jobs
- jobs(options: JobListOptions): JobList!
jobsById
me
- me: CurrentUser
order
orders
- orders(options: OrderListOptions): OrderList!
paymentMethod
- paymentMethod(id: ID!): PaymentMethod
paymentMethodEligibilityCheckers
- paymentMethodEligibilityCheckers: [ConfigurableOperationDefinition!]!
paymentMethodHandlers
- paymentMethodHandlers: [ConfigurableOperationDefinition!]!
paymentMethods
- paymentMethods(options: PaymentMethodListOptions): PaymentMethodList!
pendingSearchIndexUpdates
- pendingSearchIndexUpdates: Int!
previewCollectionVariants
Used for real-time previews of the contents of a Collection
- previewCollectionVariants(input: PreviewCollectionVariantsInput!, options: ProductVariantListOptions): ProductVariantList!
product
Get a Product either by id or slug. If neither id nor slug is specified, an error will result.
productOptionGroup
- productOptionGroup(id: ID!): ProductOptionGroup
productOptionGroups
- productOptionGroups(filterTerm: String): [ProductOptionGroup!]!
productVariant
Get a ProductVariant by id
- productVariant(id: ID!): ProductVariant
productVariants
List ProductVariants either all or for the specific product.
- productVariants(options: ProductVariantListOptions, productId: ID): ProductVariantList!
products
List Products
- products(options: ProductListOptions): ProductList!
promotion
promotionActions
- promotionActions: [ConfigurableOperationDefinition!]!
promotionConditions
- promotionConditions: [ConfigurableOperationDefinition!]!
promotions
- promotions(options: PromotionListOptions): PromotionList!
role
roles
- roles(options: RoleListOptions): RoleList!
search
- search(input: SearchInput!): SearchResponse!
shippingCalculators
- shippingCalculators: [ConfigurableOperationDefinition!]!
shippingEligibilityCheckers
- shippingEligibilityCheckers: [ConfigurableOperationDefinition!]!
shippingMethod
- shippingMethod(id: ID!): ShippingMethod
shippingMethods
- shippingMethods(options: ShippingMethodListOptions): ShippingMethodList!
tag
tags
- tags(options: TagListOptions): TagList!
taxCategories
- taxCategories: [TaxCategory!]!
taxCategory
- taxCategory(id: ID!): TaxCategory
taxRate
taxRates
- taxRates(options: TaxRateListOptions): TaxRateList!
testEligibleShippingMethods
- testEligibleShippingMethods(input: TestEligibleShippingMethodsInput!): [ShippingMethodQuote!]!
testShippingMethod
- testShippingMethod(input: TestShippingMethodInput!): TestShippingMethodResult!
zone
zones
- zones: [Zone!]!