Queries

activeWorkTypes

Type: [WorkType!]!

Get List of currently registered worker plugins

assortment

Type: Assortment

Get a specific assortment by ID

Arguments

Name	Description
assortmentId ID
slug String

assortments

Type: [Assortment!]!

Get all root assortments, by default sorted by sequence (ascending)

Arguments

Name	Description
queryString String
tags [LowerCaseString!]
slugs [String!]
limit Int
offset Int
includeInactive Boolean
includeLeaves Boolean
sort [SortOptionInput!]

assortmentsCount

Type: Int!

Returns total number of assortments that match a given criteria or all if no criteria is given

Arguments

Name	Description
tags [LowerCaseString!]
slugs [String!]
includeInactive Boolean
includeLeaves Boolean
queryString String

countries

Type: [Country!]!

Get all countries, by default sorted by creation date (ascending)

Arguments

Name	Description
limit Int
offset Int
includeInactive Boolean
queryString String
sort [SortOptionInput!]

countriesCount

Type: Int!

Returns total number of countries

Arguments

Name	Description
includeInactive Boolean
queryString String

country

Type: Country

Get a specific country by ID

Arguments

Name	Description
countryId ID!

currencies

Type: [Currency!]!

Get all currencies, by default sorted by creation date (ascending)

Arguments

Name	Description
limit Int
offset Int
includeInactive Boolean
queryString String
sort [SortOptionInput!]

currenciesCount

Type: Int!

Returns total number of currencies

Arguments

Name	Description
includeInactive Boolean
queryString String

currency

Type: Currency

Get a specific currency by ID

Arguments

Name	Description
currencyId ID!

deliveryInterfaces

Type: [DeliveryInterface!]!

Get all delivery interfaces filtered by type

Arguments

Name	Description
type DeliveryProviderType!

deliveryProvider

Type: DeliveryProvider

Get a specific delivery provider by ID

Arguments

Name	Description
deliveryProviderId ID!

deliveryProviders

Type: [DeliveryProvider!]!

Get all delivery providers, optionally filtered by type

Arguments

Name	Description
type DeliveryProviderType

deliveryProvidersCount

Type: Int!

Returns total number of delivery providers, optionally filtered by type

Arguments

Name	Description
type DeliveryProviderType

enrollment

Type: Enrollment

Get a specific quotation by ID

Arguments

Name	Description
enrollmentId ID!

enrollments

Type: [Enrollment!]!

Get all enrollments, by default sorted by creation date (ascending)

Arguments

Name	Description
limit Int
offset Int
queryString String
status [String!]
sort [SortOptionInput!]

enrollmentsCount

Type: Int!

Returns total number of enrollments

Arguments

Name	Description
queryString String
status [String!]

event

Type: Event

Get a specific work unit by ID

Arguments

Name	Description
eventId ID!

events

Type: [Event!]!

Get all emitted events, by default sorted by creation date (desc)

Arguments

Name	Description
types [String!]
limit Int
offset Int
queryString String
created DateTime
sort [SortOptionInput!]

eventsCount

Type: Int!

Get total count of all emitted events

Arguments

Name	Description
types [String!]
queryString String
created DateTime

eventStatistics

Type: [EventStatistics!]!

Returns aggregated report of all the events that occurred in the system

Arguments

Name	Description
types [String!]
from Timestamp
to Timestamp

filter

Type: Filter

Get a specific filter by ID

Arguments

Name	Description
filterId ID

filters

Type: [Filter!]!

Get all filters, by default sorted by creation date (ascending)

Arguments

Name	Description
limit Int
offset Int
includeInactive Boolean
queryString String
sort [SortOptionInput!]

filtersCount

Type: Int!

Returns total number of filters

Arguments

Name	Description
includeInactive Boolean
queryString String

language

Type: Language

Get a specific language

Arguments

Name	Description
languageId ID!

languages

Type: [Language]!

Get all languages, by default sorted by creation date (ascending)

Arguments

Name	Description
limit Int
offset Int
includeInactive Boolean
queryString String
sort [SortOptionInput!]

languagesCount

Type: Int!

Returns total number languages

Arguments

Name	Description
includeInactive Boolean
queryString String

me

Type: User

Currently logged in user

order

Type: Order

Get a specific single order

Arguments

Name	Description
orderId ID!

orders

Type: [Order!]!

Get all orders, by default sorted by creation date (descending)

Arguments

Name	Description
limit Int
offset Int
includeCarts Boolean
queryString String
status [OrderStatus!]
sort [SortOptionInput!]

ordersCount

Type: Int!

Returns total number of orders

Arguments

Name	Description
includeCarts Boolean
queryString String

orderStatistics

Type: OrderStatistics!

Returns aggregated report of all the orders that occurred in the system

Arguments

Name	Description
from Timestamp
to Timestamp

paymentInterfaces

Type: [PaymentInterface!]!

Get all payment interfaces filtered by type

Arguments

Name	Description
type PaymentProviderType!

paymentProvider

Type: PaymentProvider

Get a specific payment provider by ID

Arguments

Name	Description
paymentProviderId ID!

paymentProviders

Type: [PaymentProvider!]!

Get all payment providers, optionally filtered by type

Arguments

Name	Description
type PaymentProviderType

paymentProvidersCount

Type: Int!

Returns total number of payment providers, optionally filtered by type

Arguments

Name	Description
type PaymentProviderType

product

Type: Product

Get a specific product by id or slug

Arguments

Name	Description
productId ID
slug String

productCatalogPrices

Type: [ProductCatalogPrice!]!

List products specified prices

Arguments

Name	Description
productId ID!

productReview

Type: ProductReview!

Get a specific product review by ID

Arguments

Name	Description
productReviewId ID!

productReviews

Type: [ProductReview!]!

Get all product reviews, by default sorted by creation date (descending)

Arguments

Name	Description
limit Int
offset Int
sort [SortOptionInput!]
queryString String

productReviewsCount

Type: Int!

Returns total number of product reviews

Arguments

Name	Description
queryString String

products

Type: [Product!]!

Simple list of published products filtered either by tags or explicit slugs If a slug is provided, limit and offset don't have any effect on the result By default sorted by sequence (ascending) and published (ascending) unless a queryString is set

Arguments

Name	Description
queryString String
tags [LowerCaseString!]
slugs [String!]
limit Int
offset Int
includeDrafts Boolean
sort [SortOptionInput!]

productsCount

Type: Int!

Return total number of published products filtered either by tags or explicit slugs If a slug is provided

Arguments

Name	Description
tags [LowerCaseString!]
slugs [String!]
includeDrafts Boolean
queryString String

quotation

Type: Quotation

Get a specific quotation by ID

Arguments

Name	Description
quotationId ID!

quotations

Type: [Quotation!]!

Get all quotations, by default sorted by creation date (ascending)

Arguments

Name	Description
limit Int
offset Int
queryString String
sort [SortOptionInput!]

quotationsCount

Type: Int!

Returns total number of quotations

Arguments

Name	Description
queryString String

searchAssortments

Type: AssortmentSearchResult!

Search assortments

Arguments

Name	Description
queryString String
assortmentIds [ID!]
orderBy SearchOrderBy
includeInactive Boolean

searchProducts

Type: ProductSearchResult!

Search products

Arguments

Name	Description
queryString String
filterQuery [FilterQueryInput!]
assortmentId ID
orderBy SearchOrderBy
includeInactive Boolean
ignoreChildAssortments Boolean

shopInfo

Type: Shop!

Get shop-global data and the resolved country/language pair

token

Type: Token

Get token

Arguments

Name	Description
tokenId ID!

tokens

Type: [Token!]!

Get all tokens

Arguments

Name	Description
limit Int
offset Int

translatedAssortmentMediaTexts

Type: [AssortmentMediaTexts!]!

Localization: Media title/subtitle of a media that is attached to a assortment

Arguments

Name	Description
assortmentMediaId ID!

translatedAssortmentTexts

Type: [AssortmentTexts!]!

Localization: Meta data for assortments

Arguments

Name	Description
assortmentId ID!

translatedFilterTexts

Type: [FilterTexts!]!

Localization: Filters and Filter Options

Arguments

Name	Description
filterId ID!
filterOptionValue String

translatedProductMediaTexts

Type: [ProductMediaTexts!]!

Localization: Media title/subtitle of a media that is attached to a product

Arguments

Name	Description
productMediaId ID!

translatedProductTexts

Type: [ProductTexts!]!

Localization: Meta data for product

Arguments

Name	Description
productId ID!

translatedProductVariationTexts

Type: [ProductVariationTexts!]!

Localization: Variations and Variation Options

Arguments

Name	Description
productVariationId ID!
productVariationOptionValue String

user

Type: User

Specific user data if userId provided, else returns currently logged in

Arguments

Name	Description
userId ID

users

Type: [User!]!

Get list of users, by default sorted by creation date (ascending) unless a queryString is set

Arguments

Name	Description
limit Int
offset Int
includeGuests Boolean
queryString String
sort [SortOptionInput!]

usersCount

Type: Int!

Get total number of users in the system that match query

Arguments

Name	Description
includeGuests Boolean
queryString String

validateResetPasswordToken

Type: Boolean!

Determines if a token is valid/active for reset password

Arguments

Name	Description
token String!

validateVerifyEmailToken

Type: Boolean!

Determines if a token is valid/active for email verification

Arguments

Name	Description
token String!

warehousingInterfaces

Type: [WarehousingInterface!]!

Get all warehousing interfaces filtered by type

Arguments

Name	Description
type WarehousingProviderType!

warehousingProvider

Type: WarehousingProvider

Get a specific warehousing provider by ID

Arguments

Name	Description
warehousingProviderId ID!

warehousingProviders

Type: [WarehousingProvider!]!

Get all warehousing providers, optionally filtered by type

Arguments

Name	Description
type WarehousingProviderType

warehousingProvidersCount

Type: Int!

Returns total number of delivery providers, optionally filtered by type

Arguments

Name	Description
type WarehousingProviderType

work

Type: Work

Get a specific work unit by ID

Arguments

Name	Description
workId ID!

workQueue

Type: [Work!]!

Get all work from the queue, by default sorted by start date (desc), priority (desc), originalWorkId (asc) and created (asc)

Arguments

Name	Description
limit Int
offset Int
status [WorkStatus!]
created DateFilterInput
queryString String
sort [SortOptionInput!]
types [WorkType!]

workQueueCount

Type: Int!

Return total number of workers filtered the provided arguments

Arguments

Name	Description
status [WorkStatus!]
types [WorkType!]
created DateFilterInput
queryString String

workStatistics

Type: [WorkStatistics!]!

Returns aggregated report of all the worker jobs that occurred in the system

Arguments

Name	Description
types [String!]
from Timestamp
to Timestamp