Queries

Queries

activeChannel

The active Channel

activeCustomer

The active Customer

activeOrder

The active Order. Will be null until an Order is created via addItemToOrder. Once an Order reaches the state of PaymentApproved or PaymentSettled, then that Order is no longer considered “active” and this query will once again return null.

availableCountries

An array of supported Countries

collection

Returns a Collection either by its id or slug. If neither ‘id’ nor ‘slug’ is speicified, an error will result.

collections

A list of Collections available to the shop

eligibleShippingMethods

Returns a list of eligible shipping methods based on the current active Order

me

Returns information about the current authenticated User

nextOrderStates

Returns the possible next states that the activeOrder can transition to

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.

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.

product

Get a Product either by id or slug. If neither ‘id’ nor ‘slug’ is speicified, an error will result.

products

Get a list of Products

Search Products based on the criteria set by the SearchInput