Queries
activeChannel
activeCustomer
activeOrder
"""
The active Order. Will be
null
until an Order is created via `addItemToOrder`. Once an Order reaches thestate of
PaymentAuthorized
or `PaymentSettled`, then that Order is no longer considered "active" and thisquery will once again return `null`.
"""
type Query{
activeOrder: Order
}
availableCountries
collection
"""
Returns a Collection either by its id or slug. If neither 'id' nor 'slug' is specified, an error will result.
"""
type Query{
}
collections
"""
A list of Collections available to the shop
"""
type Query{
collections(options: CollectionListOptions): CollectionList!
}
eligiblePaymentMethods
"""
Returns a list of payment methods and their eligibility based on the current active Order
"""
type Query{
eligiblePaymentMethods: [PaymentMethodQuote!]!
}
eligibleShippingMethods
"""
Returns a list of eligible shipping methods based on the current active Order
"""
type Query{
eligibleShippingMethods: [ShippingMethodQuote!]!
}
facet
facets
"""
A list of Facets available to the shop
"""
type Query{
facets(options: FacetListOptions): FacetList!
}
me
nextOrderStates
"""
Returns the possible next states that the activeOrder can transition to
"""
type Query{
nextOrderStates: [String!]!
}
order
"""
Returns an Order based on the id. Note that in the Shop API, only orders belonging to the
currently-authenticated User may be queried.
"""
type Query{
}
orderByCode
"""
Returns an Order based on the order `code`. For guest Orders (i.e. Orders placed by non-authenticated Customers)
this query will only return the Order within 2 hours of the Order being placed. This allows an Order confirmation
screen to be shown immediately after completion of a guest checkout, yet prevents security risks of allowing
general anonymous access to Order data.
"""
type Query{
}
product
"""
Get a Product either by id or slug. If neither 'id' nor 'slug' is specified, an error will result.
"""
type Query{
}
products
search
"""
Search Products based on the criteria set by the `SearchInput`
"""
type Query{
search(input: SearchInput!): SearchResponse!
}