Version: Next

API Reference

This document describes all queries, mutations, and types available in the Saleor GraphQL API.

Table of Contents

Query

FieldArgumentTypeDescription
webhookWebhook

Look up a webhook by ID.

idID!

ID of the webhook.

webhooks ⚠️WebhookCountableConnection

List of webhooks.

⚠️ DEPRECATED

Use webhooks field on app(s) query instead. This field will be removed after 2020-07-31.

sortByWebhookSortingInput

Sort webhooks.

filterWebhookFilterInput

Filtering options for webhooks.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

webhookEvents[WebhookEvent]

List of all available webhook events.

webhookSamplePayloadJSONString

Retrieve a sample payload for a given webhook event based on real data. It can be useful for some integrations where sample payload is required.

eventTypeWebhookSampleEventTypeEnum!

Name of the requested event type.

warehouseWarehouse

Look up a warehouse by ID.

idID!

ID of an warehouse

warehousesWarehouseCountableConnection

List of warehouses.

filterWarehouseFilterInput
sortByWarehouseSortingInput
beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

translationsTranslatableItemConnection

Returns a list of all translatable items of a given kind.

kindTranslatableKinds!

Kind of objects to retrieve.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

translationTranslatableItem
idID!

ID of the object to retrieve.

kindTranslatableKinds!

Kind of the object to retrieve.

stockStock

Look up a stock by ID

idID!

ID of an warehouse

stocksStockCountableConnection

List of stocks.

filterStockFilterInput
beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

shopShop!

Return information about the shop.

shippingZoneShippingZone

Look up a shipping zone by ID.

idID!

ID of the shipping zone.

shippingZonesShippingZoneCountableConnection

List of the shop's shipping zones.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

digitalContentDigitalContent

Look up digital content by ID.

idID!

ID of the digital content.

digitalContentsDigitalContentCountableConnection

List of digital content.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

attributesAttributeCountableConnection

List of the shop's attributes.

filterAttributeFilterInput

Filtering options for attributes.

sortByAttributeSortingInput

Sorting options for attributes.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

attributeAttribute

Look up an attribute by ID.

idID!

ID of the attribute.

categoriesCategoryCountableConnection

List of the shop's categories.

filterCategoryFilterInput

Filtering options for categories.

sortByCategorySortingInput

Sort categories.

levelInt

Filter categories by the nesting level in the category tree.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

categoryCategory

Look up a category by ID or slug.

idID

ID of the category.

slugString

Slug of the category

collectionCollection

Look up a collection by ID.

idID

ID of the collection.

slugString

Slug of the category

collectionsCollectionCountableConnection

List of the shop's collections.

filterCollectionFilterInput

Filtering options for collections.

sortByCollectionSortingInput

Sort collections.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

productProduct

Look up a product by ID.

idID

ID of the product.

slugString

Slug of the category

productsProductCountableConnection

List of the shop's products.

filterProductFilterInput

Filtering options for products.

sortByProductOrder

Sort products.

stockAvailabilityStockAvailability

[Deprecated] Filter products by stock availability. Use the filter field instead. This field will be removed after 2020-07-31.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

productTypeProductType

Look up a product type by ID.

idID!

ID of the product type.

productTypesProductTypeCountableConnection

List of the shop's product types.

filterProductTypeFilterInput

Filtering options for product types.

sortByProductTypeSortingInput

Sort product types.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

productVariantProductVariant

Look up a product variant by ID.

idID!

ID of the product variant.

productVariantsProductVariantCountableConnection

List of product variants.

ids[ID]

Filter product variants by given IDs.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

reportProductSalesProductVariantCountableConnection

List of top selling products.

periodReportingPeriod!

Span of time.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

paymentPayment

Look up a payment by ID.

idID!

ID of the payment.

paymentsPaymentCountableConnection

List of payments.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

pagePage

Look up a page by ID or slug.

idID

ID of the page.

slugString

The slug of the page.

pagesPageCountableConnection

List of the shop's pages.

sortByPageSortingInput

Sort pages.

filterPageFilterInput

Filtering options for pages.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

homepageEventsOrderEventCountableConnection

List of activity events to display on homepage (at the moment it only contains order-events).

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

orderOrder

Look up an order by ID.

idID!

ID of an order.

ordersOrderCountableConnection

List of orders.

sortByOrderSortingInput

Sort orders.

filterOrderFilterInput

Filtering options for orders.

createdReportingPeriod

[Deprecated] Filter orders from a selected timespan. Use the filter field instead. This field will be removed after 2020-07-31.

statusOrderStatusFilter

[Deprecated] Filter order by status. Use the filter field instead. This field will be removed after 2020-07-31.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

draftOrdersOrderCountableConnection

List of draft orders.

sortByOrderSortingInput

Sort draft orders.

filterOrderDraftFilterInput

Filtering options for draft orders.

createdReportingPeriod

[Deprecated] Filter draft orders from a selected timespan. Use the filter field instead. This field will be removed after 2020-07-31.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

ordersTotalTaxedMoney

Return the total sales amount from a specific period.

periodReportingPeriod

A period of time.

orderByTokenOrder

Look up an order by token.

tokenUUID!

The order's token.

menuMenu

Look up a navigation menu by ID or name.

idID

ID of the menu.

nameString

The menu's name.

menusMenuCountableConnection

List of the storefront's menus.

sortByMenuSortingInput

Sort menus.

filterMenuFilterInput

Filtering options for menus.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

menuItemMenuItem

Look up a menu item by ID.

idID!

ID of the menu item.

menuItemsMenuItemCountableConnection

List of the storefronts's menu items.

sortByMenuItemSortingInput

Sort menus items.

filterMenuItemFilterInput

Filtering options for menu items.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

giftCardGiftCard

Look up a gift card by ID.

idID!

ID of the gift card.

giftCardsGiftCardCountableConnection

List of gift cards.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

pluginPlugin

Look up a plugin by ID.

idID!

ID of the plugin.

pluginsPluginCountableConnection

List of plugins.

filterPluginFilterInput

Filtering options for plugins.

sortByPluginSortingInput

Sort plugins.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

saleSale

Look up a sale by ID.

idID!

ID of the sale.

salesSaleCountableConnection

List of the shop's sales.

filterSaleFilterInput

Filtering options for sales.

sortBySaleSortingInput

Sort sales.

queryString

Search sales by name, value or type.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

voucherVoucher

Look up a voucher by ID.

idID!

ID of the voucher.

vouchersVoucherCountableConnection

List of the shop's vouchers.

filterVoucherFilterInput

Filtering options for vouchers.

sortByVoucherSortingInput

Sort voucher.

queryString

Search vouchers by name or code.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

exportFileExportFile

Look up a export file by ID.

idID!

ID of the export file job.

exportFilesExportFileCountableConnection

List of export files.

filterExportFileFilterInput

Filtering options for export files.

sortByExportFileSortingInput

Sort export files.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

taxTypes[TaxType]

List of all tax rates available from tax gateway.

checkoutCheckout

Look up a checkout by token.

tokenUUID

The checkout's token.

checkoutsCheckoutCountableConnection

List of checkouts.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

checkoutLineCheckoutLine

Look up a checkout line by ID.

idID

ID of the checkout line.

checkoutLinesCheckoutLineCountableConnection

List of checkout lines.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

appsInstallations[AppInstallation!]!

List of all apps installations

appsAppCountableConnection

List of the apps.

filterAppFilterInput

Filtering options for apps.

sortByAppSortingInput

Sort apps.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

appApp

Look up a app by ID.

idID!

ID of the app.

addressValidationRulesAddressValidationData

Returns address validation rules.

countryCodeCountryCode!

Two-letter ISO 3166-1 country code.

countryAreaString

Designation of a region, province or state.

cityString

City or a town name.

cityAreaString

Sublocality like a district.

addressAddress

Look up an address by ID.

idID!

ID of an address.

customersUserCountableConnection

List of the shop's customers.

filterCustomerFilterInput

Filtering options for customers.

sortByUserSortingInput

Sort customers.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

permissionGroupsGroupCountableConnection

List of permission groups.

filterPermissionGroupFilterInput

Filtering options for permission groups.

sortByPermissionGroupSortingInput

Sort permission groups.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

permissionGroupGroup

Look up permission group by ID.

idID!

ID of the group.

meUser

Return the currently authenticated user.

staffUsersUserCountableConnection

List of the shop's staff users.

filterStaffUserInput

Filtering options for staff users.

sortByUserSortingInput

Sort staff users.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

serviceAccounts ⚠️ServiceAccountCountableConnection

List of the service accounts.

⚠️ DEPRECATED

Use the apps query instead. This field will be removed after 2020-07-31.

filterServiceAccountFilterInput

Filtering options for service accounts.

sortByServiceAccountSortingInput

Sort service accounts.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

serviceAccount ⚠️ServiceAccount

Look up a service account by ID.

⚠️ DEPRECATED

Use the app query instead. This field will be removed after 2020-07-31.

idID!

ID of the service account.

userUser

Look up a user by ID.

idID!

ID of the user.

_entities[_Entity]
representations[_Any]
_service_Service

Mutation

FieldArgumentTypeDescription
webhookCreateWebhookCreate

Creates a new webhook subscription.

inputWebhookCreateInput!

Fields required to create a webhook.

webhookDeleteWebhookDelete

Deletes a webhook subscription.

idID!

ID of a webhook to delete.

webhookUpdateWebhookUpdate

Updates a webhook subscription.

idID!

ID of a webhook to update.

inputWebhookUpdateInput!

Fields required to update a webhook.

createWarehouseWarehouseCreate

Creates new warehouse.

inputWarehouseCreateInput!

Fields required to create warehouse.

updateWarehouseWarehouseUpdate

Updates given warehouse.

idID!

ID of a warehouse to update.

inputWarehouseUpdateInput!

Fields required to update warehouse.

deleteWarehouseWarehouseDelete

Deletes selected warehouse.

idID!

ID of a warehouse to delete.

assignWarehouseShippingZoneWarehouseShippingZoneAssign

Add shipping zone to given warehouse.

idID!

ID of a warehouse to update.

shippingZoneIds[ID!]!

List of shipping zone IDs.

unassignWarehouseShippingZoneWarehouseShippingZoneUnassign

Remove shipping zone from given warehouse.

idID!

ID of a warehouse to update.

shippingZoneIds[ID!]!

List of shipping zone IDs.

authorizationKeyAddAuthorizationKeyAdd

Adds an authorization key.

inputAuthorizationKeyInput!

Fields required to create an authorization key.

keyTypeAuthorizationKeyType!

Type of an authorization key to add.

authorizationKeyDeleteAuthorizationKeyDelete

Deletes an authorization key.

keyTypeAuthorizationKeyType!

Type of a key to delete.

staffNotificationRecipientCreateStaffNotificationRecipientCreate

Creates a new staff notification recipient.

inputStaffNotificationRecipientInput!

Fields required to create a staff notification recipient.

staffNotificationRecipientUpdateStaffNotificationRecipientUpdate

Updates a staff notification recipient.

idID!

ID of a staff notification recipient to update.

inputStaffNotificationRecipientInput!

Fields required to update a staff notification recipient.

staffNotificationRecipientDeleteStaffNotificationRecipientDelete

Delete staff notification recipient.

idID!

ID of a staff notification recipient to delete.

homepageCollectionUpdateHomepageCollectionUpdate

Updates homepage collection of the shop.

collectionID

Collection displayed on homepage.

shopDomainUpdateShopDomainUpdate

Updates site domain of the shop.

inputSiteDomainInput

Fields required to update site.

shopSettingsUpdateShopSettingsUpdate

Updates shop settings.

inputShopSettingsInput!

Fields required to update shop settings.

shopFetchTaxRatesShopFetchTaxRates

Fetch tax rates.

shopSettingsTranslateShopSettingsTranslate

Creates/Updates translations for Shop Settings.

inputShopSettingsTranslationInput!

Fields required to update shop settings translations.

languageCodeLanguageCodeEnum!

Translation language code.

shopAddressUpdateShopAddressUpdate

Update the shop's address. If the null value is passed, the currently selected address will be deleted.

inputAddressInput

Fields required to update shop address.

shippingPriceCreateShippingPriceCreate

Creates a new shipping price.

inputShippingPriceInput!

Fields required to create a shipping price.

shippingPriceDeleteShippingPriceDelete

Deletes a shipping price.

idID!

ID of a shipping price to delete.

shippingPriceBulkDeleteShippingPriceBulkDelete

Deletes shipping prices.

ids[ID]!

List of shipping price IDs to delete.

shippingPriceUpdateShippingPriceUpdate

Updates a new shipping price.

idID!

ID of a shipping price to update.

inputShippingPriceInput!

Fields required to update a shipping price.

shippingPriceTranslateShippingPriceTranslate

Creates/Updates translations for shipping method.

idID!

Shipping method ID.

inputNameTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

shippingZoneCreateShippingZoneCreate

Creates a new shipping zone.

inputShippingZoneCreateInput!

Fields required to create a shipping zone.

shippingZoneDeleteShippingZoneDelete

Deletes a shipping zone.

idID!

ID of a shipping zone to delete.

shippingZoneBulkDeleteShippingZoneBulkDelete

Deletes shipping zones.

ids[ID]!

List of shipping zone IDs to delete.

shippingZoneUpdateShippingZoneUpdate

Updates a new shipping zone.

idID!

ID of a shipping zone to update.

inputShippingZoneUpdateInput!

Fields required to update a shipping zone.

attributeCreateAttributeCreate

Creates an attribute.

inputAttributeCreateInput!

Fields required to create an attribute.

attributeDeleteAttributeDelete

Deletes an attribute.

idID!

ID of an attribute to delete.

attributeBulkDeleteAttributeBulkDelete

Deletes attributes.

ids[ID]!

List of attribute IDs to delete.

attributeAssignAttributeAssign

Assign attributes to a given product type.

operations[AttributeAssignInput]!

The operations to perform.

productTypeIdID!

ID of the product type to assign the attributes into.

attributeUnassignAttributeUnassign

Un-assign attributes from a given product type.

attributeIds[ID]!

The IDs of the attributes to assign.

productTypeIdID!

ID of the product type to assign the attributes into.

attributeUpdateAttributeUpdate

Updates attribute.

idID!

ID of an attribute to update.

inputAttributeUpdateInput!

Fields required to update an attribute.

attributeTranslateAttributeTranslate

Creates/Updates translations for attribute.

idID!

Attribute ID.

inputNameTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

attributeUpdateMetadata ⚠️AttributeUpdateMeta

Update public metadata for attribute.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

attributeClearMetadata ⚠️AttributeClearMeta

Clears public metadata item for attribute.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

attributeUpdatePrivateMetadata ⚠️AttributeUpdatePrivateMeta

Update public metadata for attribute.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

attributeClearPrivateMetadata ⚠️AttributeClearPrivateMeta

Clears public metadata item for attribute.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

attributeValueCreateAttributeValueCreate

Creates a value for an attribute.

attributeID!

Attribute to which value will be assigned.

inputAttributeValueCreateInput!

Fields required to create an AttributeValue.

attributeValueDeleteAttributeValueDelete

Deletes a value of an attribute.

idID!

ID of a value to delete.

attributeValueBulkDeleteAttributeValueBulkDelete

Deletes values of attributes.

ids[ID]!

List of attribute value IDs to delete.

attributeValueUpdateAttributeValueUpdate

Updates value of an attribute.

idID!

ID of an AttributeValue to update.

inputAttributeValueCreateInput!

Fields required to update an AttributeValue.

attributeValueTranslateAttributeValueTranslate

Creates/Updates translations for attribute value.

idID!

Attribute Value ID.

inputNameTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

attributeReorderValuesAttributeReorderValues

Reorder the values of an attribute.

attributeIdID!

ID of an attribute.

moves[ReorderInput]!

The list of reordering operations for given attribute values.

categoryCreateCategoryCreate

Creates a new category.

inputCategoryInput!

Fields required to create a category.

parentID

ID of the parent category. If empty, category will be top level category.

categoryDeleteCategoryDelete

Deletes a category.

idID!

ID of a category to delete.

categoryBulkDeleteCategoryBulkDelete

Deletes categories.

ids[ID]!

List of category IDs to delete.

categoryUpdateCategoryUpdate

Updates a category.

idID!

ID of a category to update.

inputCategoryInput!

Fields required to update a category.

categoryTranslateCategoryTranslate

Creates/Updates translations for Category.

idID!

Category ID.

inputTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

categoryUpdateMetadata ⚠️CategoryUpdateMeta

Update public metadata for category.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

categoryClearMetadata ⚠️CategoryClearMeta

Clears public metadata for category.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

categoryUpdatePrivateMetadata ⚠️CategoryUpdatePrivateMeta

Update private metadata for category.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

categoryClearPrivateMetadata ⚠️CategoryClearPrivateMeta

Clears private metadata for category.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

collectionAddProductsCollectionAddProducts

Adds products to a collection.

collectionIdID!

ID of a collection.

products[ID]!

List of product IDs.

collectionCreateCollectionCreate

Creates a new collection.

inputCollectionCreateInput!

Fields required to create a collection.

collectionDeleteCollectionDelete

Deletes a collection.

idID!

ID of a collection to delete.

collectionReorderProductsCollectionReorderProducts

Reorder the products of a collection.

collectionIdID!

ID of a collection.

moves[MoveProductInput]!

The collection products position operations.

collectionBulkDeleteCollectionBulkDelete

Deletes collections.

ids[ID]!

List of collection IDs to delete.

collectionBulkPublishCollectionBulkPublish

Publish collections.

ids[ID]!

List of collections IDs to (un)publish.

isPublishedBoolean!

Determine if collections will be published or not.

collectionRemoveProductsCollectionRemoveProducts

Remove products from a collection.

collectionIdID!

ID of a collection.

products[ID]!

List of product IDs.

collectionUpdateCollectionUpdate

Updates a collection.

idID!

ID of a collection to update.

inputCollectionInput!

Fields required to update a collection.

collectionTranslateCollectionTranslate

Creates/Updates translations for collection.

idID!

Collection ID.

inputTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

collectionUpdateMetadata ⚠️CollectionUpdateMeta

Update public metadata for collection.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

collectionClearMetadata ⚠️CollectionClearMeta

Clears public metadata for collection.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

collectionUpdatePrivateMetadata ⚠️CollectionUpdatePrivateMeta

Update private metadata for collection.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

collectionClearPrivateMetadata ⚠️CollectionClearPrivateMeta

Clears private metadata item for collection.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

productCreateProductCreate

Creates a new product.

inputProductCreateInput!

Fields required to create a product.

productDeleteProductDelete

Deletes a product.

idID!

ID of a product to delete.

productBulkDeleteProductBulkDelete

Deletes products.

ids[ID]!

List of product IDs to delete.

productBulkPublishProductBulkPublish

Publish products.

ids[ID]!

List of products IDs to publish.

isPublishedBoolean!

Determine if products will be published or not.

productUpdateProductUpdate

Updates an existing product.

idID!

ID of a product to update.

inputProductInput!

Fields required to update a product.

productTranslateProductTranslate

Creates/Updates translations for Product.

idID!

Product ID.

inputTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

productUpdateMetadata ⚠️ProductUpdateMeta

Update public metadata for product.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

productClearMetadata ⚠️ProductClearMeta

Clears public metadata item for product.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

productUpdatePrivateMetadata ⚠️ProductUpdatePrivateMeta

Update private metadata for product.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

productClearPrivateMetadata ⚠️ProductClearPrivateMeta

Clears private metadata item for product.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

productSetAvailabilityForPurchaseProductSetAvailabilityForPurchase

Set product availability for purchase date.

isAvailableBoolean!

Determine if product should be available for purchase.

productIdID!

Id of product that availability for purchase should be changed.

startDateDate

A start date from which a product will be available for purchase. When not set and isAvailable is set to True, the current day is assumed.

productImageCreateProductImageCreate

Create a product image. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

inputProductImageCreateInput!

Fields required to create a product image.

productVariantReorderProductVariantReorder

Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.

moves[ReorderInput]!

The list of variant reordering operations.

productIdID!

Id of product that variants order will be altered.

productImageDeleteProductImageDelete

Deletes a product image.

idID!

ID of a product image to delete.

productImageBulkDeleteProductImageBulkDelete

Deletes product images.

ids[ID]!

List of product image IDs to delete.

productImageReorderProductImageReorder

Changes ordering of the product image.

imagesIds[ID]!

IDs of a product images in the desired order.

productIdID!

Id of product that images order will be altered.

productImageUpdateProductImageUpdate

Updates a product image.

idID!

ID of a product image to update.

inputProductImageUpdateInput!

Fields required to update a product image.

productTypeCreateProductTypeCreate

Creates a new product type.

inputProductTypeInput!

Fields required to create a product type.

productTypeDeleteProductTypeDelete

Deletes a product type.

idID!

ID of a product type to delete.

productTypeBulkDeleteProductTypeBulkDelete

Deletes product types.

ids[ID]!

List of product type IDs to delete.

productTypeUpdateProductTypeUpdate

Updates an existing product type.

idID!

ID of a product type to update.

inputProductTypeInput!

Fields required to update a product type.

productTypeReorderAttributesProductTypeReorderAttributes

Reorder the attributes of a product type.

moves[ReorderInput]!

The list of attribute reordering operations.

productTypeIdID!

ID of a product type.

typeAttributeTypeEnum!

The attribute type to reorder.

productTypeUpdateMetadata ⚠️ProductTypeUpdateMeta

Update public metadata for product type.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

productTypeClearMetadata ⚠️ProductTypeClearMeta

Clears public metadata for product type.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

productTypeUpdatePrivateMetadata ⚠️ProductTypeUpdatePrivateMeta

Update private metadata for product type.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

productTypeClearPrivateMetadata ⚠️ProductTypeClearPrivateMeta

Clears private metadata for product type.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

digitalContentCreateDigitalContentCreate

Create new digital content. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

inputDigitalContentUploadInput!

Fields required to create a digital content.

variantIdID!

ID of a product variant to upload digital content.

digitalContentDeleteDigitalContentDelete

Remove digital content assigned to given variant.

variantIdID!

ID of a product variant with digital content to remove.

digitalContentUpdateDigitalContentUpdate

Update digital content.

inputDigitalContentInput!

Fields required to update a digital content.

variantIdID!

ID of a product variant with digital content to update.

digitalContentUrlCreateDigitalContentUrlCreate

Generate new URL to digital content.

inputDigitalContentUrlCreateInput!

Fields required to create a new url.

productVariantCreateProductVariantCreate

Creates a new variant for a product.

inputProductVariantCreateInput!

Fields required to create a product variant.

productVariantDeleteProductVariantDelete

Deletes a product variant.

idID!

ID of a product variant to delete.

productVariantBulkCreateProductVariantBulkCreate

Creates product variants for a given product.

productID!

ID of the product to create the variants for.

variants[ProductVariantBulkCreateInput]!

Input list of product variants to create.

productVariantBulkDeleteProductVariantBulkDelete

Deletes product variants.

ids[ID]!

List of product variant IDs to delete.

productVariantStocksCreateProductVariantStocksCreate

Creates stocks for product variant.

stocks[StockInput!]!

Input list of stocks to create.

variantIdID!

ID of a product variant for which stocks will be created.

productVariantStocksDeleteProductVariantStocksDelete

Delete stocks from product variant.

variantIdID!

ID of product variant for which stocks will be deleted.

warehouseIds[ID!]
productVariantStocksUpdateProductVariantStocksUpdate

Update stocks for product variant.

stocks[StockInput!]!

Input list of stocks to create.

variantIdID!

ID of a product variant for which stocks will be created.

productVariantUpdateProductVariantUpdate

Updates an existing variant for product.

idID!

ID of a product variant to update.

inputProductVariantInput!

Fields required to update a product variant.

productVariantSetDefaultProductVariantSetDefault

Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.

productIdID!

Id of a product that will have the default variant set.

variantIdID!

Id of a variant that will be set as default.

productVariantTranslateProductVariantTranslate

Creates/Updates translations for Product Variant.

idID!

Product Variant ID.

inputNameTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

productVariantUpdateMetadata ⚠️ProductVariantUpdateMeta

Update public metadata for product variant.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

productVariantClearMetadata ⚠️ProductVariantClearMeta

Clears public metadata for product variant.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

productVariantUpdatePrivateMetadata ⚠️ProductVariantUpdatePrivateMeta

Update private metadata for product variant.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

productVariantClearPrivateMetadata ⚠️ProductVariantClearPrivateMeta

Clears private metadata for product variant.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

variantImageAssignVariantImageAssign

Assign an image to a product variant.

imageIdID!

ID of a product image to assign to a variant.

variantIdID!

ID of a product variant.

variantImageUnassignVariantImageUnassign

Unassign an image from a product variant.

imageIdID!

ID of a product image to unassign from a variant.

variantIdID!

ID of a product variant.

paymentCapturePaymentCapture

Captures the authorized payment amount.

amountPositiveDecimal

Transaction amount.

paymentIdID!

Payment ID.

paymentRefundPaymentRefund

Refunds the captured payment amount.

amountPositiveDecimal

Transaction amount.

paymentIdID!

Payment ID.

paymentVoidPaymentVoid

Voids the authorized payment.

paymentIdID!

Payment ID.

pageCreatePageCreate

Creates a new page.

inputPageInput!

Fields required to create a page.

pageDeletePageDelete

Deletes a page.

idID!

ID of a page to delete.

pageBulkDeletePageBulkDelete

Deletes pages.

ids[ID]!

List of page IDs to delete.

pageBulkPublishPageBulkPublish

Publish pages.

ids[ID]!

List of page IDs to (un)publish.

isPublishedBoolean!

Determine if pages will be published or not.

pageUpdatePageUpdate

Updates an existing page.

idID!

ID of a page to update.

inputPageInput!

Fields required to update a page.

pageTranslatePageTranslate

Creates/Updates translations for Page.

idID!

Page ID.

inputPageTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

draftOrderCompleteDraftOrderComplete

Completes creating an order.

idID!

ID of the order that will be completed.

draftOrderCreateDraftOrderCreate

Creates a new draft order.

inputDraftOrderCreateInput!

Fields required to create an order.

draftOrderDeleteDraftOrderDelete

Deletes a draft order.

idID!

ID of a draft order to delete.

draftOrderBulkDeleteDraftOrderBulkDelete

Deletes draft orders.

ids[ID]!

List of draft order IDs to delete.

draftOrderLinesBulkDeleteDraftOrderLinesBulkDelete

Deletes order lines.

ids[ID]!

List of order lines IDs to delete.

draftOrderLinesCreateDraftOrderLinesCreate

Create order lines for a draft order.

idID!

ID of the draft order to add the lines to.

input[OrderLineCreateInput]!

Fields required to add order lines.

draftOrderLineDeleteDraftOrderLineDelete

Deletes an order line from a draft order.

idID!

ID of the order line to delete.

draftOrderLineUpdateDraftOrderLineUpdate

Updates an order line of a draft order.

idID!

ID of the order line to update.

inputOrderLineInput!

Fields required to update an order line.

draftOrderUpdateDraftOrderUpdate

Updates a draft order.

idID!

ID of an order to update.

inputDraftOrderInput!

Fields required to update an order.

orderAddNoteOrderAddNote

Adds note to the order.

orderID!

ID of the order to add a note for.

inputOrderAddNoteInput!

Fields required to create a note for the order.

orderCancelOrderCancel

Cancel an order.

idID!

ID of the order to cancel.

orderCaptureOrderCapture

Capture an order.

amountPositiveDecimal!

Amount of money to capture.

idID!

ID of the order to capture.

orderClearPrivateMeta ⚠️OrderClearPrivateMeta

Clears stored private metadata value.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

orderClearMeta ⚠️OrderClearMeta

Clears stored metadata value.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

inputMetaPath!

Fields required to update new or stored metadata item.

tokenUUID!

Token of an object to clear.

orderFulfillOrderFulfill

Creates new fulfillments for an order.

inputOrderFulfillInput!

Fields required to create an fulfillment.

orderID

ID of the order to be fulfilled.

orderFulfillmentCancelFulfillmentCancel

Cancels existing fulfillment and optionally restocks items.

idID!

ID of an fulfillment to cancel.

inputFulfillmentCancelInput!

Fields required to cancel an fulfillment.

orderFulfillmentUpdateTrackingFulfillmentUpdateTracking

Updates a fulfillment for an order.

idID!

ID of an fulfillment to update.

inputFulfillmentUpdateTrackingInput!

Fields required to update an fulfillment.

orderFulfillmentClearMeta ⚠️FulfillmentClearMeta

Clears metadata for fulfillment.

⚠️ DEPRECATED

Use the deleteMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

orderFulfillmentClearPrivateMeta ⚠️FulfillmentClearPrivateMeta

Clears private metadata for fulfillment.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

orderFulfillmentUpdateMeta ⚠️FulfillmentUpdateMeta

Updates metadata for fulfillment.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

orderFulfillmentUpdatePrivateMeta ⚠️FulfillmentUpdatePrivateMeta

Updates metadata for fulfillment.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

orderMarkAsPaidOrderMarkAsPaid

Mark order as manually paid.

idID!

ID of the order to mark paid.

orderRefundOrderRefund

Refund an order.

amountPositiveDecimal!

Amount of money to refund.

idID!

ID of the order to refund.

orderUpdateOrderUpdate

Updates an order.

idID!

ID of an order to update.

inputOrderUpdateInput!

Fields required to update an order.

orderUpdateMeta ⚠️OrderUpdateMeta

Updates meta for order.

⚠️ DEPRECATED

Use the updateMetadata mutation instead. This field will be removed after 2020-07-31.

inputMetaInput!

Fields required to update new or stored metadata item.

tokenUUID!

Token of an object to update.

orderUpdatePrivateMeta ⚠️OrderUpdatePrivateMeta

Updates private meta for order.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

orderUpdateShippingOrderUpdateShipping

Updates a shipping method of the order.

orderID!

ID of the order to update a shipping method.

inputOrderUpdateShippingInput

Fields required to change shipping method of the order.

orderVoidOrderVoid

Void an order.

idID!

ID of the order to void.

orderBulkCancelOrderBulkCancel

Cancels orders.

ids[ID]!

List of orders IDs to cancel.

deleteMetadataDeleteMetadata

Delete metadata of an object.

idID!

ID of an object to update.

keys[String!]!

Metadata keys to delete.

deletePrivateMetadataDeletePrivateMetadata

Delete object's private metadata.

idID!

ID of an object to update.

keys[String!]!

Metadata keys to delete.

updateMetadataUpdateMetadata

Updates metadata of an object.

idID!

ID of an object to update.

input[MetadataInput!]!

Fields required to update the object's metadata.

updatePrivateMetadataUpdatePrivateMetadata

Updates private metadata of an object.

idID!

ID of an object to update.

input[MetadataInput!]!

Fields required to update the object's metadata.

assignNavigationAssignNavigation

Assigns storefront's navigation menus.

menuID

ID of the menu.

navigationTypeNavigationType!

Type of the navigation bar to assign the menu to.

menuCreateMenuCreate

Creates a new Menu.

inputMenuCreateInput!

Fields required to create a menu.

menuDeleteMenuDelete

Deletes a menu.

idID!

ID of a menu to delete.

menuBulkDeleteMenuBulkDelete

Deletes menus.

ids[ID]!

List of menu IDs to delete.

menuUpdateMenuUpdate

Updates a menu.

idID!

ID of a menu to update.

inputMenuInput!

Fields required to update a menu.

menuItemCreateMenuItemCreate

Creates a new menu item.

inputMenuItemCreateInput!

Fields required to update a menu item. Only one of url, category, page, collection is allowed per item.

menuItemDeleteMenuItemDelete

Deletes a menu item.

idID!

ID of a menu item to delete.

menuItemBulkDeleteMenuItemBulkDelete

Deletes menu items.

ids[ID]!

List of menu item IDs to delete.

menuItemUpdateMenuItemUpdate

Updates a menu item.

idID!

ID of a menu item to update.

inputMenuItemInput!

Fields required to update a menu item. Only one of url, category, page, collection is allowed per item.

menuItemTranslateMenuItemTranslate

Creates/Updates translations for Menu Item.

idID!

Menu Item ID.

inputNameTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

menuItemMoveMenuItemMove

Moves items of menus.

menuID!

ID of the menu.

moves[MenuItemMoveInput]!

The menu position data.

invoiceRequestInvoiceRequest

Request an invoice for the order using plugin.

numberString

Invoice number, if not provided it will be generated.

orderIdID!

ID of the order related to invoice.

invoiceRequestDeleteInvoiceRequestDelete

Requests deletion of an invoice.

idID!

ID of an invoice to request the deletion.

invoiceCreateInvoiceCreate

Creates a ready to send invoice.

inputInvoiceCreateInput!

Fields required when creating an invoice.

orderIdID!

ID of the order related to invoice.

invoiceDeleteInvoiceDelete

Deletes an invoice.

idID!

ID of an invoice to delete.

invoiceUpdateInvoiceUpdate

Updates an invoice.

idID!

ID of an invoice to update.

inputUpdateInvoiceInput!

Fields to use when updating an invoice.

invoiceSendEmailInvoiceSendEmail

Send an invoice by email.

idID!

ID of an invoice to be sent.

giftCardActivateGiftCardActivate

Activate a gift card.

idID!

ID of a gift card to activate.

giftCardCreateGiftCardCreate

Creates a new gift card.

inputGiftCardCreateInput!

Fields required to create a gift card.

giftCardDeactivateGiftCardDeactivate

Deactivate a gift card.

idID!

ID of a gift card to deactivate.

giftCardUpdateGiftCardUpdate

Update a gift card.

idID!

ID of a gift card to update.

inputGiftCardUpdateInput!

Fields required to update a gift card.

pluginUpdatePluginUpdate

Update plugin configuration.

idID!

ID of plugin to update.

inputPluginUpdateInput!

Fields required to update a plugin configuration.

saleCreateSaleCreate

Creates a new sale.

inputSaleInput!

Fields required to create a sale.

saleDeleteSaleDelete

Deletes a sale.

idID!

ID of a sale to delete.

saleBulkDeleteSaleBulkDelete

Deletes sales.

ids[ID]!

List of sale IDs to delete.

saleUpdateSaleUpdate

Updates a sale.

idID!

ID of a sale to update.

inputSaleInput!

Fields required to update a sale.

saleCataloguesAddSaleAddCatalogues

Adds products, categories, collections to a voucher.

idID!

ID of a sale.

inputCatalogueInput!

Fields required to modify catalogue IDs of sale.

saleCataloguesRemoveSaleRemoveCatalogues

Removes products, categories, collections from a sale.

idID!

ID of a sale.

inputCatalogueInput!

Fields required to modify catalogue IDs of sale.

saleTranslateSaleTranslate

Creates/updates translations for a sale.

idID!

Voucher ID.

inputNameTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

voucherCreateVoucherCreate

Creates a new voucher.

inputVoucherInput!

Fields required to create a voucher.

voucherDeleteVoucherDelete

Deletes a voucher.

idID!

ID of a voucher to delete.

voucherBulkDeleteVoucherBulkDelete

Deletes vouchers.

ids[ID]!

List of voucher IDs to delete.

voucherUpdateVoucherUpdate

Updates a voucher.

idID!

ID of a voucher to update.

inputVoucherInput!

Fields required to update a voucher.

voucherCataloguesAddVoucherAddCatalogues

Adds products, categories, collections to a voucher.

idID!

ID of a voucher.

inputCatalogueInput!

Fields required to modify catalogue IDs of voucher.

voucherCataloguesRemoveVoucherRemoveCatalogues

Removes products, categories, collections from a voucher.

idID!

ID of a voucher.

inputCatalogueInput!

Fields required to modify catalogue IDs of voucher.

voucherTranslateVoucherTranslate

Creates/Updates translations for Voucher.

idID!

Voucher ID.

inputNameTranslationInput!
languageCodeLanguageCodeEnum!

Translation language code.

exportProductsExportProducts

Export products to csv file.

inputExportProductsInput!

Fields required to export product data

checkoutAddPromoCodeCheckoutAddPromoCode

Adds a gift card or a voucher to a checkout.

checkoutIdID!

Checkout ID.

promoCodeString!

Gift card code or voucher code.

checkoutBillingAddressUpdateCheckoutBillingAddressUpdate

Update billing address in the existing checkout.

billingAddressAddressInput!

The billing address of the checkout.

checkoutIdID!

ID of the checkout.

checkoutCompleteCheckoutComplete

Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.

checkoutIdID!

Checkout ID.

paymentDataJSONString

Client-side generated data required to finalize the payment.

redirectUrlString

URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.

storeSourceBoolean

Determines whether to store the payment source for future usage.

checkoutCreateCheckoutCreate

Create a new checkout.

inputCheckoutCreateInput!

Fields required to create checkout.

checkoutCustomerAttachCheckoutCustomerAttach

Sets the customer as the owner of the checkout.

checkoutIdID!

ID of the checkout.

customerIdID

[Deprecated] The ID of the customer. To identify a customer you should authenticate with JWT. This field will be removed after 2020-07-31.

checkoutCustomerDetachCheckoutCustomerDetach

Removes the user assigned as the owner of the checkout.

checkoutIdID!

Checkout ID.

checkoutEmailUpdateCheckoutEmailUpdate

Updates email address in the existing checkout object.

checkoutIdID

Checkout ID.

emailString!

email.

checkoutLineDeleteCheckoutLineDelete

Deletes a CheckoutLine.

checkoutIdID!

The ID of the checkout.

lineIdID

ID of the checkout line to delete.

checkoutLinesAddCheckoutLinesAdd

Adds a checkout line to the existing checkout.

checkoutIdID!

The ID of the checkout.

lines[CheckoutLineInput]!

A list of checkout lines, each containing information about an item in the checkout.

checkoutLinesUpdateCheckoutLinesUpdate

Updates checkout line in the existing checkout.

checkoutIdID!

The ID of the checkout.

lines[CheckoutLineInput]!

A list of checkout lines, each containing information about an item in the checkout.

checkoutRemovePromoCodeCheckoutRemovePromoCode

Remove a gift card or a voucher from a checkout.

checkoutIdID!

Checkout ID.

promoCodeString!

Gift card code or voucher code.

checkoutPaymentCreateCheckoutPaymentCreate

Create a new payment for given checkout.

checkoutIdID!

Checkout ID.

inputPaymentInput!

Data required to create a new payment.

checkoutShippingAddressUpdateCheckoutShippingAddressUpdate

Update shipping address in the existing checkout.

checkoutIdID!

ID of the checkout.

shippingAddressAddressInput!

The mailing address to where the checkout will be shipped.

checkoutShippingMethodUpdateCheckoutShippingMethodUpdate

Updates the shipping address of the checkout.

checkoutIdID

Checkout ID.

shippingMethodIdID!

Shipping method.

checkoutUpdateMetadata ⚠️CheckoutUpdateMeta

Updates metadata for checkout.

⚠️ DEPRECATED

Use the updateMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

checkoutClearMetadata ⚠️CheckoutClearMeta

Clear metadata for checkout.

⚠️ DEPRECATED

Use the deleteMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

checkoutUpdatePrivateMetadata ⚠️CheckoutUpdatePrivateMeta

Updates private metadata for checkout.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

checkoutClearPrivateMetadata ⚠️CheckoutClearPrivateMeta

Clear private metadata for checkout.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

appCreateAppCreate

Creates a new app.

inputAppInput!

Fields required to create a new app.

appUpdateAppUpdate

Updates an existing app.

idID!

ID of an app to update.

inputAppInput!

Fields required to update an existing app.

appDeleteAppDelete

Deletes an app.

idID!

ID of an app to delete.

appTokenCreateAppTokenCreate

Creates a new token.

inputAppTokenInput!

Fields required to create a new auth token.

appTokenDeleteAppTokenDelete

Deletes an authentication token assigned to app.

idID!

ID of an auth token to delete.

appTokenVerifyAppTokenVerify

Verify provided app token.

tokenString!

App token to verify.

appInstallAppInstall

Install new app by using app manifest.

inputAppInstallInput!

Fields required to install a new app.

appRetryInstallAppRetryInstall

Retry failed installation of new app.

activateAfterInstallationBoolean

Determine if app will be set active or not.

idID!

ID of failed installation.

appDeleteFailedInstallationAppDeleteFailedInstallation

Delete failed installation.

idID!

ID of failed installation to delete.

appFetchManifestAppFetchManifest

Fetch and validate manifest.

manifestUrlString!
appActivateAppActivate

Activate the app.

idID!

ID of app to activate.

appDeactivateAppDeactivate

Deactivate the app.

idID!

ID of app to deactivate.

tokenCreateCreateToken

Create JWT token.

emailString!

Email of a user.

passwordString!

Password of a user.

tokenRefreshRefreshToken

Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie.

csrfTokenString

CSRF token required to refresh token. This argument is required when refreshToken is provided as a cookie.

refreshTokenString

Refresh token.

tokenVerifyVerifyToken

Verify JWT token.

tokenString!

JWT token to validate.

tokensDeactivateAllDeactivateAllUserTokens

Deactivate all JWT tokens of the currently authenticated user.

requestPasswordResetRequestPasswordReset

Sends an email with the account password modification link.

emailString!

Email of the user that will be used for password recovery.

redirectUrlString!

URL of a view where users should be redirected to reset the password. URL in RFC 1808 format.

confirmAccountConfirmAccount

Confirm user account with token sent by email during registration.

emailString!

E-mail of the user performing account confirmation.

tokenString!

A one-time token required to confirm the account.

setPasswordSetPassword

Sets the user's password from the token sent by email using the RequestPasswordReset mutation.

emailString!

Email of a user.

passwordString!

Password of a user.

tokenString!

A one-time token required to set the password.

passwordChangePasswordChange

Change the password of the logged in user.

newPasswordString!

New user password.

oldPasswordString!

Current user password.

requestEmailChangeRequestEmailChange

Request email change of the logged in user.

newEmailString!

New user email.

passwordString!

User password.

redirectUrlString!

URL of a view where users should be redirected to update the email address. URL in RFC 1808 format.

confirmEmailChangeConfirmEmailChange

Confirm the email change of the logged-in user.

tokenString!

A one-time token required to change the email.

accountAddressCreateAccountAddressCreate

Create a new address for the customer.

inputAddressInput!

Fields required to create address.

typeAddressTypeEnum

A type of address. If provided, the new address will be automatically assigned as the customer's default address of that type.

accountAddressUpdateAccountAddressUpdate

Updates an address of the logged-in user.

idID!

ID of the address to update.

inputAddressInput!

Fields required to update the address.

accountAddressDeleteAccountAddressDelete

Delete an address of the logged-in user.

idID!

ID of the address to delete.

accountSetDefaultAddressAccountSetDefaultAddress

Sets a default address for the authenticated user.

idID!

ID of the address to set as default.

typeAddressTypeEnum!

The type of address.

accountRegisterAccountRegister

Register a new user.

inputAccountRegisterInput!

Fields required to create a user.

accountUpdateAccountUpdate

Updates the account of the logged-in user.

inputAccountInput!

Fields required to update the account of the logged-in user.

accountRequestDeletionAccountRequestDeletion

Sends an email with the account removal link for the logged-in user.

redirectUrlString!

URL of a view where users should be redirected to delete their account. URL in RFC 1808 format.

accountDeleteAccountDelete

Remove user account.

tokenString!

A one-time token required to remove account. Sent by email using AccountRequestDeletion mutation.

accountUpdateMeta ⚠️AccountUpdateMeta

Updates metadata of the logged-in user.

⚠️ DEPRECATED

Use the updateMetadata mutation. This field will be removed after 2020-07-31.

inputMetaInput!

Fields required to update new or stored metadata item.

addressCreateAddressCreate

Creates user address.

inputAddressInput!

Fields required to create address.

userIdID!

ID of a user to create address for.

addressUpdateAddressUpdate

Updates an address.

idID!

ID of the address to update.

inputAddressInput!

Fields required to update the address.

addressDeleteAddressDelete

Deletes an address.

idID!

ID of the address to delete.

addressSetDefaultAddressSetDefault

Sets a default address for the given user.

addressIdID!

ID of the address.

typeAddressTypeEnum!

The type of address.

userIdID!

ID of the user to change the address for.

customerCreateCustomerCreate

Creates a new customer.

inputUserCreateInput!

Fields required to create a customer.

customerUpdateCustomerUpdate

Updates an existing customer.

idID!

ID of a customer to update.

inputCustomerInput!

Fields required to update a customer.

customerDeleteCustomerDelete

Deletes a customer.

idID!

ID of a customer to delete.

customerBulkDeleteCustomerBulkDelete

Deletes customers.

ids[ID]!

List of user IDs to delete.

staffCreateStaffCreate

Creates a new staff user.

inputStaffCreateInput!

Fields required to create a staff user.

staffUpdateStaffUpdate

Updates an existing staff user.

idID!

ID of a staff user to update.

inputStaffUpdateInput!

Fields required to update a staff user.

staffDeleteStaffDelete

Deletes a staff user.

idID!

ID of a staff user to delete.

staffBulkDeleteStaffBulkDelete

Deletes staff users.

ids[ID]!

List of user IDs to delete.

userAvatarUpdateUserAvatarUpdate

Create a user avatar. Only for staff members. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

imageUpload!

Represents an image file in a multipart request.

userAvatarDeleteUserAvatarDelete

Deletes a user avatar. Only for staff members.

userBulkSetActiveUserBulkSetActive

Activate or deactivate users.

ids[ID]!

List of user IDs to (de)activate).

isActiveBoolean!

Determine if users will be set active or not.

userUpdateMetadata ⚠️UserUpdateMeta

Updates metadata for user.

⚠️ DEPRECATED

Use the updateMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

userClearMetadata ⚠️UserClearMeta

Clear metadata for user.

⚠️ DEPRECATED

Use the deleteMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

userUpdatePrivateMetadata ⚠️UserUpdatePrivateMeta

Updates private metadata for user.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

userClearPrivateMetadata ⚠️UserClearPrivateMeta

Clear private metadata for user.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation. This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

serviceAccountCreate ⚠️ServiceAccountCreate

Creates a new service account.

⚠️ DEPRECATED

Use the appCreate mutation instead. This field will be removed after 2020-07-31.

inputServiceAccountInput!

Fields required to create a new service account.

serviceAccountUpdate ⚠️ServiceAccountUpdate

Updates an existing service account.

⚠️ DEPRECATED

Use the appUpdate mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a service account to update.

inputServiceAccountInput!

Fields required to update an existing service account.

serviceAccountDelete ⚠️ServiceAccountDelete

Deletes a service account.

⚠️ DEPRECATED

Use the appDelete mutation instead. This field will be removed after 2020-07-31.

idID!

ID of a service account to delete.

serviceAccountUpdatePrivateMetadata ⚠️ServiceAccountUpdatePrivateMeta

Updates private metadata for a service account.

⚠️ DEPRECATED

Use the updatePrivateMetadata mutation with App instead.This field will be removed after 2020-07-31.

idID!

ID of an object to update.

inputMetaInput!

Fields required to update new or stored metadata item.

serviceAccountClearPrivateMetadata ⚠️ServiceAccountClearPrivateMeta

Clear private metadata for a service account.

⚠️ DEPRECATED

Use the deletePrivateMetadata mutation with App instead.This field will be removed after 2020-07-31.

idID!

ID of a customer to update.

inputMetaPath!

Fields required to identify stored metadata item.

serviceAccountTokenCreate ⚠️ServiceAccountTokenCreate

Creates a new token.

⚠️ DEPRECATED

Use the appTokenCreate mutation instead. This field will be removed after 2020-07-31.

inputServiceAccountTokenInput!

Fields required to create a new auth token.

serviceAccountTokenDelete ⚠️ServiceAccountTokenDelete

Deletes an authentication token assigned to service account.

⚠️ DEPRECATED

Use the appTokenDelete mutation instead. This field will be removed after 2020-07-31.

idID!

ID of an auth token to delete.

permissionGroupCreatePermissionGroupCreate

Create new permission group.

inputPermissionGroupCreateInput!

Input fields to create permission group.

permissionGroupUpdatePermissionGroupUpdate

Update permission group.

idID!

ID of the group to update.

inputPermissionGroupUpdateInput!

Input fields to create permission group.

permissionGroupDeletePermissionGroupDelete

Delete permission group.

idID!

ID of the group to delete.

Objects

AccountAddressCreate

Create a new address for the customer.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user instance for which the address was created.

accountErrors[AccountError!]!
addressAddress

AccountAddressDelete

Delete an address of the logged-in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user instance for which the address was deleted.

accountErrors[AccountError!]!
addressAddress

AccountAddressUpdate

Updates an address of the logged-in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user object for which the address was edited.

accountErrors[AccountError!]!
addressAddress

AccountDelete

Remove user account.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

AccountError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeAccountErrorCode!

The error code.

AccountRegister

Register a new user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

requiresConfirmationBoolean

Informs whether users need to confirm their email address.

accountErrors[AccountError!]!
userUser

AccountRequestDeletion

Sends an email with the account removal link for the logged-in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!

AccountSetDefaultAddress

Sets a default address for the authenticated user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

An updated user instance.

accountErrors[AccountError!]!

AccountUpdate

Updates the account of the logged-in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

AccountUpdateMeta

Updates metadata of the logged-in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

Address

Represents user address data.

FieldArgumentTypeDescription
idID!

The ID of the object.

firstNameString!
lastNameString!
companyNameString!
streetAddress1String!
streetAddress2String!
cityString!
cityAreaString!
postalCodeString!
countryCountryDisplay!

Shop's default country.

countryAreaString!
phoneString
isDefaultShippingAddressBoolean

Address is user's default shipping address.

isDefaultBillingAddressBoolean

Address is user's default billing address.

AddressCreate

Creates user address.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user instance for which the address was created.

accountErrors[AccountError!]!
addressAddress

AddressDelete

Deletes an address.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user instance for which the address was deleted.

accountErrors[AccountError!]!
addressAddress

AddressSetDefault

Sets a default address for the given user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

An updated user instance.

accountErrors[AccountError!]!

AddressUpdate

Updates an address.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user object for which the address was edited.

accountErrors[AccountError!]!
addressAddress

AddressValidationData

FieldArgumentTypeDescription
countryCodeString
countryNameString
addressFormatString
addressLatinFormatString
allowedFields[String]
requiredFields[String]
upperFields[String]
countryAreaTypeString
countryAreaChoices[ChoiceValue]
cityTypeString
cityChoices[ChoiceValue]
cityAreaTypeString
cityAreaChoices[ChoiceValue]
postalCodeTypeString
postalCodeMatchers[String]
postalCodeExamples[String]
postalCodePrefixString

App

Represents app data.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString

Name of the app.

createdDateTime

The date and time when the app was created.

isActiveBoolean

Determine if app will be set active or not.

permissions[Permission]

List of the app's permissions.

tokens[AppToken]

Last 4 characters of the tokens.

privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

typeAppTypeEnum

Type of the app.

webhooks[Webhook]

List of webhooks assigned to this app.

aboutAppString

Description of this app.

dataPrivacyString

Description of the data privacy defined for this app.

dataPrivacyUrlString

Url to details about the privacy policy on the app owner page.

homepageUrlString

Homepage of the app.

supportUrlString

Support page for the app.

configurationUrlString

Url to iframe with the configuration for the app.

appUrlString

Url to iframe with the app.

versionString

Version number of the app.

accessTokenString

JWT token used to authenticate by thridparty app.

AppActivate

Activate the app.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appApp

AppCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[AppCountableEdge!]!
totalCountInt

A total count of items in the collection.

AppCountableEdge

FieldArgumentTypeDescription
nodeApp!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

AppCreate

Creates a new app.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

authTokenString

The newly created authentication token.

appErrors[AppError!]!
appApp

AppDeactivate

Deactivate the app.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appApp

AppDelete

Deletes an app.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appApp

AppDeleteFailedInstallation

Delete failed installation.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appInstallationAppInstallation

AppError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeAppErrorCode!

The error code.

permissions[PermissionEnum!]

List of permissions which causes the error.

AppFetchManifest

Fetch and validate manifest.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

manifestManifest
appErrors[AppError!]!

AppInstall

Install new app by using app manifest.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appInstallationAppInstallation

AppInstallation

Represents ongoing installation of app.

FieldArgumentTypeDescription
appNameString!
manifestUrlString!
idID!

The ID of the object.

statusJobStatusEnum!

Job status.

createdAtDateTime!

Created date time of job in ISO 8601 format.

updatedAtDateTime!

Date time of job last update in ISO 8601 format.

messageString

Job message.

AppRetryInstall

Retry failed installation of new app.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appInstallationAppInstallation

AppToken

Represents token data.

FieldArgumentTypeDescription
nameString

Name of the authenticated token.

authTokenString

Last 4 characters of the token.

idID!

The ID of the object.

AppTokenCreate

Creates a new token.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

authTokenString

The newly created authentication token.

appErrors[AppError!]!
appTokenAppToken

AppTokenDelete

Deletes an authentication token assigned to app.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appTokenAppToken

AppTokenVerify

Verify provided app token.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

validBoolean!

Determine if token is valid or not.

appErrors[AppError!]!

AppUpdate

Updates an existing app.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

appErrors[AppError!]!
appApp

AssignNavigation

Assigns storefront's navigation menus.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuMenu

Assigned navigation menu.

menuErrors[MenuError!]!

Attribute

Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.

FieldArgumentTypeDescription
idID!

The ID of the object.

productTypesProductTypeCountableConnection!
beforeString
afterString
firstInt
lastInt
productVariantTypesProductTypeCountableConnection!
beforeString
afterString
firstInt
lastInt
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

inputTypeAttributeInputTypeEnum

The input type to use for entering attribute values in the dashboard.

nameString

Name of an attribute displayed in the interface.

slugString

Internal representation of an attribute name.

values[AttributeValue]

List of attribute's values.

valueRequiredBoolean!

Whether the attribute requires values to be passed or not.

visibleInStorefrontBoolean!

Whether the attribute should be visible or not in storefront.

filterableInStorefrontBoolean!

Whether the attribute can be filtered in storefront.

filterableInDashboardBoolean!

Whether the attribute can be filtered in dashboard.

availableInGridBoolean!

Whether the attribute can be displayed in the admin product list.

translationAttributeTranslation

Returns translated attribute fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for attribute.

storefrontSearchPositionInt!

The position of the attribute in the storefront navigation (0 by default).

AttributeAssign

Assign attributes to a given product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productTypeProductType

The updated product type.

productErrors[ProductAttributeError!]!

AttributeBulkDelete

Deletes attributes.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

AttributeClearMeta

Clears public metadata item for attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
attributeAttribute

AttributeClearPrivateMeta

Clears public metadata item for attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
attributeAttribute

AttributeCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[AttributeCountableEdge!]!
totalCountInt

A total count of items in the collection.

AttributeCountableEdge

FieldArgumentTypeDescription
nodeAttribute!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

AttributeCreate

Creates an attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

attributeAttribute
productErrors[ProductError!]!

AttributeDelete

Deletes an attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
attributeAttribute

AttributeReorderValues

Reorder the values of an attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

attributeAttribute

Attribute from which values are reordered.

productErrors[ProductError!]!

AttributeTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
translationAttributeTranslation

Returns translated attribute fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for attribute.

attributeAttribute

Custom attribute of a product.

AttributeTranslate

Creates/Updates translations for attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
attributeAttribute

AttributeTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
languageLanguageDisplay!

Translation language.

AttributeUnassign

Un-assign attributes from a given product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productTypeProductType

The updated product type.

productErrors[ProductError!]!

AttributeUpdate

Updates attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

attributeAttribute
productErrors[ProductError!]!

AttributeUpdateMeta

Update public metadata for attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
attributeAttribute

AttributeUpdatePrivateMeta

Update public metadata for attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
attributeAttribute

AttributeValue

Represents a value of an attribute.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString

Name of a value displayed in the interface.

slugString

Internal representation of a value (unique per attribute).

type ⚠️AttributeValueType

Type of value (used only when value field is set).

⚠️ DEPRECATED

Use the inputType field to determine the type of attribute's value. This field will be removed after 2020-07-31.

translationAttributeValueTranslation

Returns translated attribute value fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for attribute value.

inputTypeAttributeInputTypeEnum

The input type to use for entering attribute values in the dashboard.

AttributeValueBulkDelete

Deletes values of attributes.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

AttributeValueCreate

Creates a value for an attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

attributeAttribute

The updated attribute.

productErrors[ProductError!]!
attributeValueAttributeValue

AttributeValueDelete

Deletes a value of an attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

attributeAttribute

The updated attribute.

productErrors[ProductError!]!
attributeValueAttributeValue

AttributeValueTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
translationAttributeValueTranslation

Returns translated attribute value fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for attribute value.

attributeValueAttributeValue

Represents a value of an attribute.

AttributeValueTranslate

Creates/Updates translations for attribute value.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
attributeValueAttributeValue

AttributeValueTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
languageLanguageDisplay!

Translation language.

AttributeValueUpdate

Updates value of an attribute.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

attributeAttribute

The updated attribute.

productErrors[ProductError!]!
attributeValueAttributeValue

AuthorizationKey

FieldArgumentTypeDescription
nameAuthorizationKeyType!

Name of the authorization backend.

keyString!

Authorization key (client ID).

AuthorizationKeyAdd

Adds an authorization key.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

authorizationKeyAuthorizationKey

Newly added authorization key.

shopShop

Updated shop.

shopErrors[ShopError!]!

AuthorizationKeyDelete

Deletes an authorization key.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

authorizationKeyAuthorizationKey

Authorization key that was deleted.

shopShop

Updated shop.

shopErrors[ShopError!]!

BulkProductError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeProductErrorCode!

The error code.

indexInt

Index of an input list item that caused the error.

warehouses[ID!]

List of warehouse IDs which causes the error.

BulkStockError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeProductErrorCode!

The error code.

indexInt

Index of an input list item that caused the error.

Category

Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront.

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

nameString!
descriptionString!
descriptionJsonJSONString!
slugString!
parentCategory
levelInt!
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

ancestorsCategoryCountableConnection

List of ancestors of the category.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

productsProductCountableConnection

List of products in the category.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

url ⚠️String

The storefront's URL for the category.

⚠️ DEPRECATED

This field will be removed after 2020-07-31.

childrenCategoryCountableConnection

List of children of the category.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

backgroundImageImage
sizeInt

Size of the image.

translationCategoryTranslation

Returns translated category fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for category.

CategoryBulkDelete

Deletes categories.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

CategoryClearMeta

Clears public metadata for category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
categoryCategory

CategoryClearPrivateMeta

Clears private metadata for category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
categoryCategory

CategoryCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[CategoryCountableEdge!]!
totalCountInt

A total count of items in the collection.

CategoryCountableEdge

FieldArgumentTypeDescription
nodeCategory!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

CategoryCreate

Creates a new category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
categoryCategory

CategoryDelete

Deletes a category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
categoryCategory

CategoryTranslatableContent

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

nameString!
descriptionString!
descriptionJsonJSONString!
translationCategoryTranslation

Returns translated category fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for category.

categoryCategory

Represents a single category of products.

CategoryTranslate

Creates/Updates translations for Category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
categoryCategory

CategoryTranslation

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

nameString!
descriptionString!
descriptionJsonJSONString!
languageLanguageDisplay!

Translation language.

CategoryUpdate

Updates a category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
categoryCategory

CategoryUpdateMeta

Update public metadata for category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
categoryCategory

CategoryUpdatePrivateMeta

Update private metadata for category.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
categoryCategory

Checkout

Checkout object.

FieldArgumentTypeDescription
createdDateTime!
lastChangeDateTime!
userUser
quantityInt!
billingAddressAddress
shippingAddressAddress
shippingMethodShippingMethod
noteString!
discountMoney
discountNameString
translatedDiscountNameString
voucherCodeString
giftCards[GiftCard]

List of gift cards associated with this checkout.

idID!

The ID of the object.

privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

availableShippingMethods[ShippingMethod]!

Shipping methods that can be used with this order.

availablePaymentGateways[PaymentGateway!]!

List of available payment gateways.

emailString!

Email of a customer.

isShippingRequiredBoolean!

Returns True, if checkout requires shipping.

lines[CheckoutLine]

A list of checkout lines, each containing information about an item in the checkout.

shippingPriceTaxedMoney

The price of the shipping, with all the taxes included.

subtotalPriceTaxedMoney

The price of the checkout before shipping, with taxes included.

tokenUUID!

The checkout's token.

totalPriceTaxedMoney

The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included.

CheckoutAddPromoCode

Adds a gift card or a voucher to a checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

The checkout with the added gift card or voucher.

checkoutErrors[CheckoutError!]!

CheckoutBillingAddressUpdate

Update billing address in the existing checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutClearMeta

Clear metadata for checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutErrors[CheckoutError!]!
checkoutCheckout

CheckoutClearPrivateMeta

Clear private metadata for checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutErrors[CheckoutError!]!
checkoutCheckout

CheckoutComplete

Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Placed order.

confirmationNeededBoolean!

Set to true if payment needs to be confirmed before checkout is complete.

confirmationDataJSONString

Confirmation data used to process additional authorization steps.

checkoutErrors[CheckoutError!]!

CheckoutCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[CheckoutCountableEdge!]!
totalCountInt

A total count of items in the collection.

CheckoutCountableEdge

FieldArgumentTypeDescription
nodeCheckout!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

CheckoutCreate

Create a new checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

createdBoolean

Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout.

checkoutErrors[CheckoutError!]!
checkoutCheckout

CheckoutCustomerAttach

Sets the customer as the owner of the checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutCustomerDetach

Removes the user assigned as the owner of the checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutEmailUpdate

Updates email address in the existing checkout object.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeCheckoutErrorCode!

The error code.

variants[ID!]

List of varint IDs which causes the error.

CheckoutLine

Represents an item in the checkout.

FieldArgumentTypeDescription
idID!

The ID of the object.

variantProductVariant!
quantityInt!
totalPriceTaxedMoney

The sum of the checkout line price, taxes and discounts.

requiresShippingBoolean

Indicates whether the item need to be delivered.

CheckoutLineCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[CheckoutLineCountableEdge!]!
totalCountInt

A total count of items in the collection.

CheckoutLineCountableEdge

FieldArgumentTypeDescription
nodeCheckoutLine!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

CheckoutLineDelete

Deletes a CheckoutLine.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutLinesAdd

Adds a checkout line to the existing checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutLinesUpdate

Updates checkout line in the existing checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutPaymentCreate

Create a new payment for given checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

Related checkout object.

paymentPayment

A newly created payment.

paymentErrors[PaymentError!]!

CheckoutRemovePromoCode

Remove a gift card or a voucher from a checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

The checkout with the removed gift card or voucher.

checkoutErrors[CheckoutError!]!

CheckoutShippingAddressUpdate

Update shipping address in the existing checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutShippingMethodUpdate

Updates the shipping address of the checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutCheckout

An updated checkout.

checkoutErrors[CheckoutError!]!

CheckoutUpdateMeta

Updates metadata for checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutErrors[CheckoutError!]!
checkoutCheckout

CheckoutUpdatePrivateMeta

Updates private metadata for checkout.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

checkoutErrors[CheckoutError!]!
checkoutCheckout

ChoiceValue

FieldArgumentTypeDescription
rawString
verboseString

Collection

Represents a collection of products.

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

nameString!
descriptionString!
descriptionJsonJSONString!
publicationDateDate
isPublishedBoolean!
slugString!
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

productsProductCountableConnection

List of products in this collection.

filterProductFilterInput

Filtering options for products.

sortByProductOrder

Sort products.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

backgroundImageImage
sizeInt

Size of the image.

translationCollectionTranslation

Returns translated collection fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for collection.

CollectionAddProducts

Adds products to a collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

collectionCollection

Collection to which products will be added.

productErrors[ProductError!]!

CollectionBulkDelete

Deletes collections.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

CollectionBulkPublish

Publish collections.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

CollectionClearMeta

Clears public metadata for collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
collectionCollection

CollectionClearPrivateMeta

Clears private metadata item for collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
collectionCollection

CollectionCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[CollectionCountableEdge!]!
totalCountInt

A total count of items in the collection.

CollectionCountableEdge

FieldArgumentTypeDescription
nodeCollection!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

CollectionCreate

Creates a new collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
collectionCollection

CollectionDelete

Deletes a collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
collectionCollection

CollectionRemoveProducts

Remove products from a collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

collectionCollection

Collection from which products will be removed.

productErrors[ProductError!]!

CollectionReorderProducts

Reorder the products of a collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

collectionCollection

Collection from which products are reordered.

productErrors[ProductError!]!

CollectionTranslatableContent

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

nameString!
descriptionString!
descriptionJsonJSONString!
translationCollectionTranslation

Returns translated collection fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for collection.

collectionCollection

Represents a collection of products.

CollectionTranslate

Creates/Updates translations for collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
collectionCollection

CollectionTranslation

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

nameString!
descriptionString!
descriptionJsonJSONString!
languageLanguageDisplay!

Translation language.

CollectionUpdate

Updates a collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
collectionCollection

CollectionUpdateMeta

Update public metadata for collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
collectionCollection

CollectionUpdatePrivateMeta

Update private metadata for collection.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
collectionCollection

ConfigurationItem

Stores information about a single configuration field.

FieldArgumentTypeDescription
nameString!

Name of the field.

valueString

Current value of the field.

typeConfigurationTypeFieldEnum

Type of the field.

helpTextString

Help text for the field.

labelString

Label for the field.

ConfirmAccount

Confirm user account with token sent by email during registration.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

An activated user account.

accountErrors[AccountError!]!

ConfirmEmailChange

Confirm the email change of the logged-in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user instance with a new email.

accountErrors[AccountError!]!

CountryDisplay

FieldArgumentTypeDescription
codeString!

Country code.

countryString!

Country name.

vatVAT

Country tax.

CreateToken

Create JWT token.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

tokenString

JWT token, required to authenticate.

refreshTokenString

JWT refresh token, required to re-generate access token.

csrfTokenString

CSRF token required to re-generate access token.

userUser

A user instance.

accountErrors[AccountError!]!

CreditCard

FieldArgumentTypeDescription
brandString!

Card brand.

firstDigitsString

First 4 digits of the card number.

lastDigitsString!

Last 4 digits of the card number.

expMonthInt

Two-digit number representing the card’s expiration month.

expYearInt

Four-digit number representing the card’s expiration year.

CustomerBulkDelete

Deletes customers.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

accountErrors[AccountError!]!

CustomerCreate

Creates a new customer.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

CustomerDelete

Deletes a customer.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

CustomerEvent

History log of the customer.

FieldArgumentTypeDescription
idID!

The ID of the object.

dateDateTime

Date when event happened at in ISO 8601 format.

typeCustomerEventsEnum

Customer event type.

userUser

User who performed the action.

messageString

Content of the event.

countInt

Number of objects concerned by the event.

orderOrder

The concerned order.

orderLineOrderLine

The concerned order line.

CustomerUpdate

Updates an existing customer.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

DeactivateAllUserTokens

Deactivate all JWT tokens of the currently authenticated user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!

DeleteMetadata

Delete metadata of an object.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

metadataErrors[MetadataError!]!
itemObjectWithMetadata

DeletePrivateMetadata

Delete object's private metadata.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

metadataErrors[MetadataError!]!
itemObjectWithMetadata

DigitalContent

FieldArgumentTypeDescription
useDefaultSettingsBoolean!
automaticFulfillmentBoolean!
productVariantProductVariant!
contentFileString!
maxDownloadsInt
urlValidDaysInt
urls[DigitalContentUrl]

List of URLs for the digital variant.

idID!

The ID of the object.

privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

DigitalContentCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[DigitalContentCountableEdge!]!
totalCountInt

A total count of items in the collection.

DigitalContentCountableEdge

FieldArgumentTypeDescription
nodeDigitalContent!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

DigitalContentCreate

Create new digital content. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

variantProductVariant
contentDigitalContent
productErrors[ProductError!]!

DigitalContentDelete

Remove digital content assigned to given variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

variantProductVariant
productErrors[ProductError!]!

DigitalContentUpdate

Update digital content.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

variantProductVariant
contentDigitalContent
productErrors[ProductError!]!

DigitalContentUrl

FieldArgumentTypeDescription
contentDigitalContent!
createdDateTime!
downloadNumInt!
idID!

The ID of the object.

urlString

URL for digital content.

tokenUUID!

UUID of digital content.

DigitalContentUrlCreate

Generate new URL to digital content.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
digitalContentUrlDigitalContentUrl

DiscountError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeDiscountErrorCode!

The error code.

Domain

Represents shop's domain.

FieldArgumentTypeDescription
hostString!

The host name of the domain.

sslEnabledBoolean!

Inform if SSL is enabled.

urlString!

Shop's absolute URL.

DraftOrderBulkDelete

Deletes draft orders.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

orderErrors[OrderError!]!

DraftOrderComplete

Completes creating an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Completed order.

orderErrors[OrderError!]!

DraftOrderCreate

Creates a new draft order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderErrors[OrderError!]!
orderOrder

DraftOrderDelete

Deletes a draft order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderErrors[OrderError!]!
orderOrder

DraftOrderLineDelete

Deletes an order line from a draft order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

A related draft order.

orderLineOrderLine

An order line that was deleted.

orderErrors[OrderError!]!

DraftOrderLineUpdate

Updates an order line of a draft order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

A related draft order.

orderErrors[OrderError!]!
orderLineOrderLine

DraftOrderLinesBulkDelete

Deletes order lines.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

orderErrors[OrderError!]!

DraftOrderLinesCreate

Create order lines for a draft order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

A related draft order.

orderLines[OrderLine!]

List of newly added order lines.

orderErrors[OrderError!]!

DraftOrderUpdate

Updates a draft order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderErrors[OrderError!]!
orderOrder

Error

Represents an error in the input of a mutation.

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

ExportError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeExportErrorCode!

The error code.

ExportEvent

History log of export file.

FieldArgumentTypeDescription
idID!

The ID of the object.

dateDateTime!

Date when event happened at in ISO 8601 format.

typeExportEventsEnum!

Export event type.

userUser

User who performed the action.

appApp

App which performed the action.

messageString!

Content of the event.

ExportFile

Represents a job data of exported file.

FieldArgumentTypeDescription
idID!

The ID of the object.

userUser
appApp
statusJobStatusEnum!

Job status.

createdAtDateTime!

Created date time of job in ISO 8601 format.

updatedAtDateTime!

Date time of job last update in ISO 8601 format.

messageString

Job message.

urlString

The URL of field to download.

events[ExportEvent!]

List of events associated with the export.

ExportFileCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[ExportFileCountableEdge!]!
totalCountInt

A total count of items in the collection.

ExportFileCountableEdge

FieldArgumentTypeDescription
nodeExportFile!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

ExportProducts

Export products to csv file.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

exportFileExportFile

The newly created export file job which is responsible for export data.

exportErrors[ExportError!]!

Fulfillment

Represents order fulfillment.

FieldArgumentTypeDescription
idID!

The ID of the object.

fulfillmentOrderInt!
statusFulfillmentStatus!
trackingNumberString!
createdDateTime!
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

lines[FulfillmentLine]

List of lines for the fulfillment.

statusDisplayString

User-friendly fulfillment status.

warehouseWarehouse

Warehouse from fulfillment was fulfilled.

FulfillmentCancel

Cancels existing fulfillment and optionally restocks items.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

fulfillmentFulfillment

A canceled fulfillment.

orderOrder

Order which fulfillment was cancelled.

orderErrors[OrderError!]!

FulfillmentClearMeta

Clears metadata for fulfillment.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

fulfillmentFulfillment

FulfillmentClearPrivateMeta

Clears private metadata for fulfillment.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

fulfillmentFulfillment

FulfillmentLine

Represents line of the fulfillment.

FieldArgumentTypeDescription
idID!

The ID of the object.

quantityInt!
orderLineOrderLine

FulfillmentUpdateMeta

Updates metadata for fulfillment.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

fulfillmentFulfillment

FulfillmentUpdatePrivateMeta

Updates metadata for fulfillment.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

fulfillmentFulfillment

FulfillmentUpdateTracking

Updates a fulfillment for an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

fulfillmentFulfillment

A fulfillment with updated tracking.

orderOrder

Order for which fulfillment was updated.

orderErrors[OrderError!]!

GatewayConfigLine

Payment gateway client configuration key and value pair.

FieldArgumentTypeDescription
fieldString!

Gateway config key.

valueString

Gateway config value for key.

Geolocalization

Represents customers's geolocalization data.

FieldArgumentTypeDescription
countryCountryDisplay

Country of the user acquired by his IP address.

GiftCard

A gift card is a prepaid electronic payment card accepted in stores. They can be used during checkout by providing a valid gift card codes.

FieldArgumentTypeDescription
codeString

Gift card code.

userUser

The customer who bought a gift card.

createdDateTime!
startDateDate!
endDateDate
lastUsedOnDateTime
isActiveBoolean!
initialBalanceMoney
currentBalanceMoney
idID!

The ID of the object.

displayCodeString

Code in format which allows displaying in a user interface.

GiftCardActivate

Activate a gift card.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

giftCardGiftCard

A gift card to activate.

giftCardErrors[GiftCardError!]!

GiftCardCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[GiftCardCountableEdge!]!
totalCountInt

A total count of items in the collection.

GiftCardCountableEdge

FieldArgumentTypeDescription
nodeGiftCard!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

GiftCardCreate

Creates a new gift card.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

giftCardErrors[GiftCardError!]!
giftCardGiftCard

GiftCardDeactivate

Deactivate a gift card.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

giftCardGiftCard

A gift card to deactivate.

giftCardErrors[GiftCardError!]!

GiftCardError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeGiftCardErrorCode!

The error code.

GiftCardUpdate

Update a gift card.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

giftCardErrors[GiftCardError!]!
giftCardGiftCard

Group

Represents permission group data.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
permissions[Permission]

List of group permissions

users[User]

List of group users

userCanManageBoolean!

True, if the currently authenticated user has rights to manage a group.

GroupCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[GroupCountableEdge!]!
totalCountInt

A total count of items in the collection.

GroupCountableEdge

FieldArgumentTypeDescription
nodeGroup!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

HomepageCollectionUpdate

Updates homepage collection of the shop.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopShop

Updated shop.

shopErrors[ShopError!]!

Image

Represents an image.

FieldArgumentTypeDescription
urlString!

The URL of the image.

altString

Alt text for an image.

Invoice

Represents an Invoice.

FieldArgumentTypeDescription
idID!

The ID of the object.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

statusJobStatusEnum!

Job status.

numberString
externalUrlString
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

createdAtDateTime!

Created date time of job in ISO 8601 format.

updatedAtDateTime!

Date time of job last update in ISO 8601 format.

messageString

Job message.

urlString

URL to download an invoice.

InvoiceCreate

Creates a ready to send invoice.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

invoiceErrors[InvoiceError!]!
invoiceInvoice

InvoiceDelete

Deletes an invoice.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

invoiceErrors[InvoiceError!]!
invoiceInvoice

InvoiceError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeInvoiceErrorCode!

The error code.

InvoiceRequest

Request an invoice for the order using plugin.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Order related to an invoice.

invoiceErrors[InvoiceError!]!
invoiceInvoice

InvoiceRequestDelete

Requests deletion of an invoice.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

invoiceErrors[InvoiceError!]!
invoiceInvoice

InvoiceSendEmail

Send an invoice by email.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

invoiceErrors[InvoiceError!]!
invoiceInvoice

InvoiceUpdate

Updates an invoice.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

invoiceErrors[InvoiceError!]!
invoiceInvoice

LanguageDisplay

FieldArgumentTypeDescription
codeLanguageCodeEnum!

ISO 639 representation of the language name.

languageString!

Full name of the language.

Manifest

The manifest definition.

FieldArgumentTypeDescription
identifierString!
versionString!
nameString!
aboutString
permissions[Permission]
appUrlString
configurationUrlString
tokenTargetUrlString
dataPrivacyString
dataPrivacyUrlString
homepageUrlString
supportUrlString

Margin

FieldArgumentTypeDescription
startInt
stopInt

Menu

Represents a single menu - an object that is used to help navigate through the store.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
items[MenuItem]

MenuBulkDelete

Deletes menus.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

menuErrors[MenuError!]!

MenuCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[MenuCountableEdge!]!
totalCountInt

A total count of items in the collection.

MenuCountableEdge

FieldArgumentTypeDescription
nodeMenu!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

MenuCreate

Creates a new Menu.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuErrors[MenuError!]!
menuMenu

MenuDelete

Deletes a menu.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuErrors[MenuError!]!
menuMenu

MenuError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeMenuErrorCode!

The error code.

MenuItem

Represents a single item of the related menu. Can store categories, collection or pages.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
menuMenu!
parentMenuItem
categoryCategory
collectionCollection
pagePage
levelInt!
children[MenuItem]
urlString

URL to the menu item.

translationMenuItemTranslation

Returns translated menu item fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for menu item.

MenuItemBulkDelete

Deletes menu items.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

menuErrors[MenuError!]!

MenuItemCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[MenuItemCountableEdge!]!
totalCountInt

A total count of items in the collection.

MenuItemCountableEdge

FieldArgumentTypeDescription
nodeMenuItem!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

MenuItemCreate

Creates a new menu item.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuErrors[MenuError!]!
menuItemMenuItem

MenuItemDelete

Deletes a menu item.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuErrors[MenuError!]!
menuItemMenuItem

MenuItemMove

Moves items of menus.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuMenu

Assigned menu to move within.

menuErrors[MenuError!]!

MenuItemTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
translationMenuItemTranslation

Returns translated menu item fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for menu item.

menuItemMenuItem

Represents a single item of the related menu. Can store categories, collection or pages.

MenuItemTranslate

Creates/Updates translations for Menu Item.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
menuItemMenuItem

MenuItemTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
languageLanguageDisplay!

Translation language.

MenuItemUpdate

Updates a menu item.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuErrors[MenuError!]!
menuItemMenuItem

MenuUpdate

Updates a menu.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

menuErrors[MenuError!]!
menuMenu

MetaClientStore

FieldArgumentTypeDescription
nameString!

Metadata client's name.

metadata[MetaItem]!

Metadata stored for a client.

MetaItem

FieldArgumentTypeDescription
keyString!

Key of a metadata item.

valueString!

Value of a metadata item.

MetaStore

FieldArgumentTypeDescription
namespaceString!

Name of metadata client group.

clients[MetaClientStore]!

List of clients that stored metadata in a group.

MetadataError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeMetadataErrorCode!

The error code.

MetadataItem

FieldArgumentTypeDescription
keyString!

Key of a metadata item.

valueString!

Value of a metadata item.

Money

Represents amount of money in specific currency.

FieldArgumentTypeDescription
currencyString!

Currency code.

amountFloat!

Amount of money.

localized ⚠️String!

Money formatted according to the current locale.

⚠️ DEPRECATED

Price formatting according to the current locale should be handled by the frontend client. This field will be removed after 2020-07-31.

MoneyRange

Represents a range of amounts of money.

FieldArgumentTypeDescription
startMoney

Lower bound of a price range.

stopMoney

Upper bound of a price range.

Navigation

Represents shop's navigation menus.

FieldArgumentTypeDescription
mainMenu

Main navigation bar.

secondaryMenu

Secondary navigation bar.

Order

Represents an order in the shop.

FieldArgumentTypeDescription
idID!

The ID of the object.

createdDateTime!
statusOrderStatus!
userUser
languageCodeString!
trackingClientIdString!
billingAddressAddress
shippingAddressAddress
shippingMethodShippingMethod
shippingMethodNameString
shippingPriceTaxedMoney

Total price of shipping.

tokenString!
voucherVoucher
giftCards[GiftCard]

List of user gift cards.

discountMoney
discountNameString
translatedDiscountNameString
displayGrossPricesBoolean!
customerNoteString!
weightWeight
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

fulfillments[Fulfillment]!

List of shipments for the order.

lines[OrderLine]!

List of order lines.

actions[OrderAction]!

List of actions that can be performed in the current state of an order.

availableShippingMethods[ShippingMethod]

Shipping methods that can be used with this order.

invoices[Invoice]

List of order invoices.

numberString

User-friendly number of an order.

isPaidBoolean

Informs if an order is fully paid.

paymentStatusPaymentChargeStatusEnum

Internal payment status.

paymentStatusDisplayString

User-friendly payment status.

payments[Payment]

List of payments for the order.

totalTaxedMoney

Total amount of the order.

subtotalTaxedMoney

The sum of line prices not including shipping.

statusDisplayString

User-friendly order status.

canFinalizeBoolean!

Informs whether a draft order can be finalized(turned into a regular order).

totalAuthorizedMoney

Amount authorized for the order.

totalCapturedMoney

Amount captured by payment.

events[OrderEvent]

List of events associated with the order.

totalBalanceMoney!

The difference between the paid and the order total amount.

userEmailString

Email address of the customer.

isShippingRequiredBoolean!

Returns True, if order requires shipping.

OrderAddNote

Adds note to the order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Order with the note added.

eventOrderEvent

Order note created.

orderErrors[OrderError!]!

OrderBulkCancel

Cancels orders.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

orderErrors[OrderError!]!

OrderCancel

Cancel an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Canceled order.

orderErrors[OrderError!]!

OrderCapture

Capture an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Captured order.

orderErrors[OrderError!]!

OrderClearMeta

Clears stored metadata value.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

OrderClearPrivateMeta

Clears stored private metadata value.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

OrderCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[OrderCountableEdge!]!
totalCountInt

A total count of items in the collection.

OrderCountableEdge

FieldArgumentTypeDescription
nodeOrder!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

OrderError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeOrderErrorCode!

The error code.

warehouseID

Warehouse ID which causes the error.

orderLineID

Order line ID which causes the error.

OrderEvent

History log of the order.

FieldArgumentTypeDescription
idID!

The ID of the object.

dateDateTime

Date when event happened at in ISO 8601 format.

typeOrderEventsEnum

Order event type.

userUser

User who performed the action.

messageString

Content of the event.

emailString

Email of the customer.

emailTypeOrderEventsEmailsEnum

Type of an email sent to the customer.

amountFloat

Amount of money.

paymentIdString

The payment ID from the payment gateway.

paymentGatewayString

The payment gateway of the payment.

quantityInt

Number of items.

composedIdString

Composed ID of the Fulfillment.

orderNumberString

User-friendly number of an order.

invoiceNumberString

Number of an invoice related to the order.

oversoldItems[String]

List of oversold lines names.

lines[OrderEventOrderLineObject]

The concerned lines.

fulfilledItems[FulfillmentLine]

The lines fulfilled.

warehouseWarehouse

The warehouse were items were restocked.

OrderEventCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[OrderEventCountableEdge!]!
totalCountInt

A total count of items in the collection.

OrderEventCountableEdge

FieldArgumentTypeDescription
nodeOrderEvent!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

OrderEventOrderLineObject

FieldArgumentTypeDescription
quantityInt

The variant quantity.

orderLineOrderLine

The order line.

itemNameString

The variant name.

OrderFulfill

Creates new fulfillments for an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

fulfillments[Fulfillment]

List of created fulfillments.

orderOrder

Fulfilled order.

orderErrors[OrderError!]!

OrderLine

Represents order line of particular order.

FieldArgumentTypeDescription
idID!

The ID of the object.

productNameString!
variantNameString!
productSkuString!
isShippingRequiredBoolean!
quantityInt!
quantityFulfilledInt!
taxRateFloat!
digitalContentUrlDigitalContentUrl
thumbnailImage

The main thumbnail for the ordered product.

sizeInt

Size of thumbnail.

unitPriceTaxedMoney

Price of the single item in the order line.

totalPriceTaxedMoney

Price of the order line.

variantProductVariant

A purchased product variant. Note: this field may be null if the variant has been removed from stock at all.

translatedProductNameString!

Product name in the customer's language

translatedVariantNameString!

Variant name in the customer's language

OrderMarkAsPaid

Mark order as manually paid.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Order marked as paid.

orderErrors[OrderError!]!

OrderRefund

Refund an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

A refunded order.

orderErrors[OrderError!]!

OrderUpdate

Updates an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderErrors[OrderError!]!
orderOrder

OrderUpdateMeta

Updates meta for order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

OrderUpdatePrivateMeta

Updates private meta for order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

OrderUpdateShipping

Updates a shipping method of the order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

Order with updated shipping method.

orderErrors[OrderError!]!

OrderVoid

Void an order.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

orderOrder

A voided order.

orderErrors[OrderError!]!

Page

A static page that can be manually added by a shop operator through the dashboard.

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

titleString!
contentString!
contentJsonJSONString!
publicationDateDate
isPublishedBoolean!
slugString!
createdDateTime!
translationPageTranslation

Returns translated page fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for page.

PageBulkDelete

Deletes pages.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

pageErrors[PageError!]!

PageBulkPublish

Publish pages.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

pageErrors[PageError!]!

PageCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[PageCountableEdge!]!
totalCountInt

A total count of items in the collection.

PageCountableEdge

FieldArgumentTypeDescription
nodePage!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

PageCreate

Creates a new page.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

pageErrors[PageError!]!
pagePage

PageDelete

Deletes a page.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

pageErrors[PageError!]!
pagePage

PageError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codePageErrorCode!

The error code.

PageInfo

The Relay compliant PageInfo type, containing data necessary to paginate this connection.

FieldArgumentTypeDescription
hasNextPageBoolean!

When paginating forwards, are there more items?

hasPreviousPageBoolean!

When paginating backwards, are there more items?

startCursorString

When paginating backwards, the cursor to continue.

endCursorString

When paginating forwards, the cursor to continue.

PageTranslatableContent

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

titleString!
contentString!
contentJsonJSONString!
translationPageTranslation

Returns translated page fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for page.

pagePage

('A static page that can be manually added by a shop operator ', 'through the dashboard.')

PageTranslate

Creates/Updates translations for Page.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
pagePageTranslatableContent

PageTranslation

FieldArgumentTypeDescription
seoTitleString
seoDescriptionString
idID!

The ID of the object.

titleString!
contentString!
contentJsonJSONString!
languageLanguageDisplay!

Translation language.

PageUpdate

Updates an existing page.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

pageErrors[PageError!]!
pagePage

PasswordChange

Change the password of the logged in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user instance with a new password.

accountErrors[AccountError!]!

Payment

Represents a payment of a given type.

FieldArgumentTypeDescription
idID!

The ID of the object.

gatewayString!
isActiveBoolean!
createdDateTime!
modifiedDateTime!
tokenString!
checkoutCheckout
orderOrder
customerIpAddressString
chargeStatusPaymentChargeStatusEnum!

Internal payment status.

actions[OrderAction]!

List of actions that can be performed in the current state of a payment.

totalMoney

Total amount of the payment.

capturedAmountMoney

Total amount captured for this payment.

transactions[Transaction]

List of all transactions within this payment.

availableCaptureAmountMoney

Maximum amount of money that can be captured.

availableRefundAmountMoney

Maximum amount of money that can be refunded.

creditCardCreditCard

The details of the card used for this payment.

PaymentCapture

Captures the authorized payment amount.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

paymentPayment

Updated payment.

paymentErrors[PaymentError!]!

PaymentCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[PaymentCountableEdge!]!
totalCountInt

A total count of items in the collection.

PaymentCountableEdge

FieldArgumentTypeDescription
nodePayment!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

PaymentError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codePaymentErrorCode!

The error code.

PaymentGateway

Available payment gateway backend with configuration necessary to setup client.

FieldArgumentTypeDescription
nameString!

Payment gateway name.

idID!

Payment gateway ID.

config[GatewayConfigLine!]!

Payment gateway client configuration.

currencies[String]!

Payment gateway supported currencies.

PaymentRefund

Refunds the captured payment amount.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

paymentPayment

Updated payment.

paymentErrors[PaymentError!]!

PaymentSource

Represents a payment source stored for user in payment gateway, such as credit card.

FieldArgumentTypeDescription
gatewayString!

Payment gateway name.

creditCardInfoCreditCard

Stored credit card details if available.

PaymentVoid

Voids the authorized payment.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

paymentPayment

Updated payment.

paymentErrors[PaymentError!]!

Permission

Represents a permission object in a friendly form.

FieldArgumentTypeDescription
codePermissionEnum!

Internal code for permission.

nameString!

Describe action(s) allowed to do by permission.

PermissionGroupCreate

Create new permission group.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

permissionGroupErrors[PermissionGroupError!]!
groupGroup

PermissionGroupDelete

Delete permission group.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

permissionGroupErrors[PermissionGroupError!]!
groupGroup

PermissionGroupError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codePermissionGroupErrorCode!

The error code.

permissions[PermissionEnum!]

List of permissions which causes the error.

users[ID!]

List of user IDs which causes the error.

PermissionGroupUpdate

Update permission group.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

permissionGroupErrors[PermissionGroupError!]!
groupGroup

Plugin

Plugin.

FieldArgumentTypeDescription
idID!
nameString!
descriptionString!
activeBoolean!
configuration[ConfigurationItem]

PluginCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[PluginCountableEdge!]!
totalCountInt

A total count of items in the collection.

PluginCountableEdge

FieldArgumentTypeDescription
nodePlugin!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

PluginError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codePluginErrorCode!

The error code.

PluginUpdate

Update plugin configuration.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

pluginPlugin
pluginsErrors[PluginError!]!

Product

Represents an individual item for sale in the storefront.

FieldArgumentTypeDescription
idID!

The ID of the object.

seoTitleString
seoDescriptionString
nameString!
descriptionString!
descriptionJsonJSONString!
publicationDateDate
isPublishedBoolean!
productTypeProductType!
slugString!
categoryCategory
updatedAtDateTime
chargeTaxesBoolean!
weightWeight
availableForPurchaseDate
visibleInListingsBoolean!
defaultVariantProductVariant
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

url ⚠️String!

The storefront URL for the product.

⚠️ DEPRECATED

This field will be removed after 2020-07-31.

thumbnailImage

The main thumbnail for a product.

sizeInt

Size of thumbnail.

pricingProductPricingInfo

Lists the storefront product's pricing, the current price and discounts, only meant for displaying.

isAvailableBoolean

Whether the product is in stock and visible or not.

minimalVariantPriceMoney

The price of the cheapest variant (including discounts).

taxTypeTaxType

A type of tax. Assigned by enabled tax gateway

attributes[SelectedAttribute!]!

List of attributes assigned to this product.

purchaseCostMoneyRange
marginMargin
imageByIdProductImage

Get a single product image by ID.

idID

ID of a product image.

variants[ProductVariant]

List of variants for the product.

images[ProductImage]

List of images for the product.

collections[Collection]

List of collections for the product.

translationProductTranslation

Returns translated product fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for product.

isAvailableForPurchaseBoolean

Whether the product is available for purchase.

ProductAttributeError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeProductErrorCode!

The error code.

attributes[ID!]

List of attributes IDs which causes the error.

ProductBulkDelete

Deletes products.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

ProductBulkPublish

Publish products.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

ProductClearMeta

Clears public metadata item for product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productProduct

ProductClearPrivateMeta

Clears private metadata item for product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productProduct

ProductCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[ProductCountableEdge!]!
totalCountInt

A total count of items in the collection.

ProductCountableEdge

FieldArgumentTypeDescription
nodeProduct!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

ProductCreate

Creates a new product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productProduct

ProductDelete

Deletes a product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productProduct

ProductError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeProductErrorCode!

The error code.

ProductImage

Represents a product image.

FieldArgumentTypeDescription
idID!

The ID of the object.

sortOrderInt
altString!
urlString!

The URL of the image.

sizeInt

Size of the image.

ProductImageBulkDelete

Deletes product images.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

ProductImageCreate

Create a product image. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productProduct
imageProductImage
productErrors[ProductError!]!

ProductImageDelete

Deletes a product image.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productProduct
imageProductImage
productErrors[ProductError!]!

ProductImageReorder

Changes ordering of the product image.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productProduct
images[ProductImage]
productErrors[ProductError!]!

ProductImageUpdate

Updates a product image.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productProduct
imageProductImage
productErrors[ProductError!]!

ProductPricingInfo

Represents availability of a product in the storefront.

FieldArgumentTypeDescription
onSaleBoolean

Whether it is in sale or not.

discountTaxedMoney

The discount amount if in sale (null otherwise).

discountLocalCurrencyTaxedMoney

The discount amount in the local currency.

priceRangeTaxedMoneyRange

The discounted price range of the product variants.

priceRangeUndiscountedTaxedMoneyRange

The undiscounted price range of the product variants.

priceRangeLocalCurrencyTaxedMoneyRange

The discounted price range of the product variants in the local currency.

ProductSetAvailabilityForPurchase

Set product availability for purchase date.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productProduct
productErrors[ProductError!]!

ProductTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

seoTitleString
seoDescriptionString
nameString!
descriptionString!
descriptionJsonJSONString!
translationProductTranslation

Returns translated product fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for product.

productProduct

Represents an individual item for sale in the storefront.

ProductTranslate

Creates/Updates translations for Product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
productProduct

ProductTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

seoTitleString
seoDescriptionString
nameString!
descriptionString!
descriptionJsonJSONString!
languageLanguageDisplay!

Translation language.

ProductType

Represents a type of product. It defines what attributes are available to products of this type.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
slugString!
hasVariantsBoolean!
isShippingRequiredBoolean!
isDigitalBoolean!
weightWeight
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

productsProductCountableConnection

List of products of this type.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

taxRateTaxRateType

A type of tax rate.

taxTypeTaxType

A type of tax. Assigned by enabled tax gateway

variantAttributes[Attribute]

Variant attributes of that product type.

productAttributes[Attribute]

Product attributes of that product type.

availableAttributesAttributeCountableConnection
filterAttributeFilterInput
beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

ProductTypeBulkDelete

Deletes product types.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

ProductTypeClearMeta

Clears public metadata for product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productTypeProductType

ProductTypeClearPrivateMeta

Clears private metadata for product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productTypeProductType

ProductTypeCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[ProductTypeCountableEdge!]!
totalCountInt

A total count of items in the collection.

ProductTypeCountableEdge

FieldArgumentTypeDescription
nodeProductType!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

ProductTypeCreate

Creates a new product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productTypeProductType

ProductTypeDelete

Deletes a product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productTypeProductType

ProductTypeReorderAttributes

Reorder the attributes of a product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productTypeProductType

Product type from which attributes are reordered.

productErrors[ProductError!]!

ProductTypeUpdate

Updates an existing product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productTypeProductType

ProductTypeUpdateMeta

Update public metadata for product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productTypeProductType

ProductTypeUpdatePrivateMeta

Update private metadata for product type.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productTypeProductType

ProductUpdate

Updates an existing product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productProduct

ProductUpdateMeta

Update public metadata for product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productProduct

ProductUpdatePrivateMeta

Update private metadata for product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productProduct

ProductVariant

Represents a version of a product such as different size or color.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
skuString!
productProduct!
trackInventoryBoolean!
weightWeight
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

quantity ⚠️Int!

Quantity of a product available for sale.

⚠️ DEPRECATED

Use the stock field instead. This field will be removed after 2020-07-31.

quantityAllocated ⚠️Int

Quantity allocated for orders.

⚠️ DEPRECATED

Use the stock field instead. This field will be removed after 2020-07-31.

stockQuantity ⚠️Int!

Quantity of a product available for sale.

⚠️ DEPRECATED

Use the quantityAvailable field instead. This field will be removed after 2020-07-31.

priceMoney

Base price of a product variant. This field is restricted for admins. Use the pricing field to get the public price for customers.

pricingVariantPricingInfo

Lists the storefront variant's pricing, the current price and discounts, only meant for displaying.

isAvailable ⚠️Boolean

Whether the variant is in stock and visible or not.

⚠️ DEPRECATED

Use the stock field instead. This field will be removed after 2020-07-31.

attributes[SelectedAttribute!]!

List of attributes assigned to this variant.

costPriceMoney

Cost price of the variant.

marginInt

Gross margin percentage value.

quantityOrderedInt

Total quantity ordered.

revenueTaxedMoney

Total revenue generated by a variant in given period of time. Note: this field should be queried using reportProductSales query as it uses optimizations suitable for such calculations.

periodReportingPeriod
images[ProductImage]

List of images for the product variant.

translationProductVariantTranslation

Returns translated product variant fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for product variant.

digitalContentDigitalContent

Digital content for the product variant.

stocks[Stock]

Stocks for the product variant.

countryCodeCountryCode

Two-letter ISO 3166-1 country code.

quantityAvailableInt!

Quantity of a product available for sale in one checkout.

countryCodeCountryCode

Two-letter ISO 3166-1 country code. When provided, the exact quantity from a warehouse operating in shipping zones that contain this country will be returned. Otherwise, it will return the maximum quantity from all shipping zones.

ProductVariantBulkCreate

Creates product variants for a given product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were created.

productVariants[ProductVariant!]!

List of the created variants.

bulkProductErrors[BulkProductError!]!

ProductVariantBulkDelete

Deletes product variants.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

productErrors[ProductError!]!

ProductVariantClearMeta

Clears public metadata for product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productVariantProductVariant

ProductVariantClearPrivateMeta

Clears private metadata for product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productVariantProductVariant

ProductVariantCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[ProductVariantCountableEdge!]!
totalCountInt

A total count of items in the collection.

ProductVariantCountableEdge

FieldArgumentTypeDescription
nodeProductVariant!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

ProductVariantCreate

Creates a new variant for a product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productVariantProductVariant

ProductVariantDelete

Deletes a product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productVariantProductVariant

ProductVariantReorder

Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productProduct
productErrors[ProductError!]!

ProductVariantSetDefault

Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productProduct
productErrors[ProductError!]!

ProductVariantStocksCreate

Creates stocks for product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productVariantProductVariant

Updated product variant.

bulkStockErrors[BulkStockError!]!

ProductVariantStocksDelete

Delete stocks from product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productVariantProductVariant

Updated product variant.

stockErrors[StockError!]!

ProductVariantStocksUpdate

Update stocks for product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productVariantProductVariant

Updated product variant.

bulkStockErrors[BulkStockError!]!

ProductVariantTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
translationProductVariantTranslation

Returns translated product variant fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for product variant.

productVariantProductVariant

Represents a version of a product such as different size or color.

ProductVariantTranslate

Creates/Updates translations for Product Variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
productVariantProductVariant

ProductVariantTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
languageLanguageDisplay!

Translation language.

ProductVariantUpdate

Updates an existing variant for product.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productVariantProductVariant

ProductVariantUpdateMeta

Update public metadata for product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productVariantProductVariant

ProductVariantUpdatePrivateMeta

Update private metadata for product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productErrors[ProductError!]!
productVariantProductVariant

ReducedRate

Represents a reduced VAT rate for a particular type of goods.

FieldArgumentTypeDescription
rateFloat!

Reduced VAT rate in percent.

rateTypeTaxRateType!

A type of goods.

RefreshToken

Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

tokenString

JWT token, required to authenticate.

userUser

A user instance.

accountErrors[AccountError!]!

RequestEmailChange

Request email change of the logged in user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

A user instance.

accountErrors[AccountError!]!

RequestPasswordReset

Sends an email with the account password modification link.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!

Sale

Sales allow creating discounts for categories, collections or products and are visible to all the customers.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
typeSaleType!
valueFloat!
startDateDateTime!
endDateDateTime
categoriesCategoryCountableConnection

List of categories this sale applies to.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

collectionsCollectionCountableConnection

List of collections this sale applies to.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

productsProductCountableConnection

List of products this sale applies to.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

translationSaleTranslation

Returns translated sale fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for sale.

SaleAddCatalogues

Adds products, categories, collections to a voucher.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

saleSale

Sale of which catalogue IDs will be modified.

discountErrors[DiscountError!]!

SaleBulkDelete

Deletes sales.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

discountErrors[DiscountError!]!

SaleCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[SaleCountableEdge!]!
totalCountInt

A total count of items in the collection.

SaleCountableEdge

FieldArgumentTypeDescription
nodeSale!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

SaleCreate

Creates a new sale.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

discountErrors[DiscountError!]!
saleSale

SaleDelete

Deletes a sale.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

discountErrors[DiscountError!]!
saleSale

SaleRemoveCatalogues

Removes products, categories, collections from a sale.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

saleSale

Sale of which catalogue IDs will be modified.

discountErrors[DiscountError!]!

SaleTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
translationSaleTranslation

Returns translated sale fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for sale.

saleSale

Sales allow creating discounts for categories, collections or products and are visible to all the customers.

SaleTranslate

Creates/updates translations for a sale.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
saleSale

SaleTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString
languageLanguageDisplay!

Translation language.

SaleUpdate

Updates a sale.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

discountErrors[DiscountError!]!
saleSale

SelectedAttribute

Represents a custom attribute.

FieldArgumentTypeDescription
attributeAttribute!

Name of an attribute displayed in the interface.

values[AttributeValue]!

Values of an attribute.

ServiceAccount

Represents service account data.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString

Name of the service account.

createdDateTime

The date and time when the service account was created.

isActiveBoolean

Determine if service account will be set active or not.

permissions[Permission]

List of the service's permissions.

tokens[ServiceAccountToken]

Last 4 characters of the tokens.

privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

ServiceAccountClearPrivateMeta

Clear private metadata for a service account.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
serviceAccountServiceAccount

ServiceAccountCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[ServiceAccountCountableEdge!]!
totalCountInt

A total count of items in the collection.

ServiceAccountCountableEdge

FieldArgumentTypeDescription
nodeServiceAccount!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

ServiceAccountCreate

Creates a new service account.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

authTokenString

The newly created authentication token.

accountErrors[AccountError!]!
serviceAccountServiceAccount

ServiceAccountDelete

Deletes a service account.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
serviceAccountServiceAccount

ServiceAccountToken

Represents token data.

FieldArgumentTypeDescription
nameString

Name of the authenticated token.

authTokenString

Last 4 characters of the token.

idID!

The ID of the object.

ServiceAccountTokenCreate

Creates a new token.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

authTokenString

The newly created authentication token.

accountErrors[AccountError!]!
serviceAccountTokenServiceAccountToken

ServiceAccountTokenDelete

Deletes an authentication token assigned to service account.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
serviceAccountTokenServiceAccountToken

ServiceAccountUpdate

Updates an existing service account.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
serviceAccountServiceAccount

ServiceAccountUpdatePrivateMeta

Updates private metadata for a service account.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
serviceAccountServiceAccount

SetPassword

Sets the user's password from the token sent by email using the RequestPasswordReset mutation.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

tokenString

JWT token, required to authenticate.

refreshTokenString

JWT refresh token, required to re-generate access token.

csrfTokenString

CSRF token required to re-generate access token.

userUser

A user instance.

accountErrors[AccountError!]!

ShippingError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeShippingErrorCode!

The error code.

warehouses[ID!]

List of warehouse IDs which causes the error.

ShippingMethod

Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
priceMoney
minimumOrderPriceMoney
maximumOrderPriceMoney
minimumOrderWeightWeight
maximumOrderWeightWeight
typeShippingMethodTypeEnum

Type of the shipping method.

translationShippingMethodTranslation

Returns translated shipping method fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for shipping method.

ShippingMethodTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
translationShippingMethodTranslation

Returns translated shipping method fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for shipping method.

shippingMethodShippingMethod

Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.

ShippingMethodTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString
languageLanguageDisplay!

Translation language.

ShippingPriceBulkDelete

Deletes shipping prices.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

shippingErrors[ShippingError!]!

ShippingPriceCreate

Creates a new shipping price.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shippingZoneShippingZone

A shipping zone to which the shipping method belongs.

shippingErrors[ShippingError!]!
shippingMethodShippingMethod

ShippingPriceDelete

Deletes a shipping price.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shippingMethodShippingMethod

A shipping method to delete.

shippingZoneShippingZone

A shipping zone to which the shipping method belongs.

shippingErrors[ShippingError!]!

ShippingPriceTranslate

Creates/Updates translations for shipping method.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
shippingMethodShippingMethod

ShippingPriceUpdate

Updates a new shipping price.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shippingZoneShippingZone

A shipping zone to which the shipping method belongs.

shippingErrors[ShippingError!]!
shippingMethodShippingMethod

ShippingZone

Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
defaultBoolean!
priceRangeMoneyRange

Lowest and highest prices for the shipping.

countries[CountryDisplay]

List of countries available for the method.

shippingMethods[ShippingMethod]

List of shipping methods available for orders shipped to countries within this shipping zone.

warehouses[Warehouse]

List of warehouses for shipping zone.

ShippingZoneBulkDelete

Deletes shipping zones.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

shippingErrors[ShippingError!]!

ShippingZoneCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[ShippingZoneCountableEdge!]!
totalCountInt

A total count of items in the collection.

ShippingZoneCountableEdge

FieldArgumentTypeDescription
nodeShippingZone!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

ShippingZoneCreate

Creates a new shipping zone.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shippingErrors[ShippingError!]!
shippingZoneShippingZone

ShippingZoneDelete

Deletes a shipping zone.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shippingErrors[ShippingError!]!
shippingZoneShippingZone

ShippingZoneUpdate

Updates a new shipping zone.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shippingErrors[ShippingError!]!
shippingZoneShippingZone

Shop

Represents a shop resource containing general shop data and configuration.

FieldArgumentTypeDescription
availablePaymentGateways[PaymentGateway!]!

List of available payment gateways.

currencyString

A currency for which gateways will be returned.

geolocalizationGeolocalization

Customer's geolocalization data.

authorizationKeys[AuthorizationKey]!

List of configured authorization keys. Authorization keys are used to enable third-party OAuth authorization (currently Facebook or Google).

countries[CountryDisplay!]!

List of countries available in the shop.

languageCodeLanguageCodeEnum

A language code to return the translation for.

currencies[String]!

List of available currencies.

defaultCurrencyString!

Shop's default currency.

defaultCountryCountryDisplay

Shop's default country.

defaultMailSenderNameString

Default shop's email sender's name.

defaultMailSenderAddressString

Default shop's email sender's address.

descriptionString

Shop's description.

domainDomain!

Shop's domain data.

homepageCollectionCollection

Collection displayed on homepage.

languages[LanguageDisplay]!

List of the shops's supported languages.

nameString!

Shop's name.

navigationNavigation

Shop's navigation.

permissions[Permission]!

List of available permissions.

phonePrefixes[String]!

List of possible phone prefixes.

headerTextString

Header text.

includeTaxesInPricesBoolean!

Include taxes in prices.

displayGrossPricesBoolean!

Display prices with tax in store.

chargeTaxesOnShippingBoolean!

Charge taxes on shipping.

trackInventoryByDefaultBoolean

Enable inventory tracking.

defaultWeightUnitWeightUnitsEnum

Default weight unit.

translationShopTranslation

Returns translated shop fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for shop.

automaticFulfillmentDigitalProductsBoolean

Enable automatic fulfillment for all digital products.

defaultDigitalMaxDownloadsInt

Default number of max downloads per digital content URL.

defaultDigitalUrlValidDaysInt

Default number of days which digital content URL will be valid.

companyAddressAddress

Company address.

customerSetPasswordUrlString

URL of a view where customers can set their password.

staffNotificationRecipients[StaffNotificationRecipient]

List of staff notification recipients.

ShopAddressUpdate

Update the shop's address. If the null value is passed, the currently selected address will be deleted.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopShop

Updated shop.

shopErrors[ShopError!]!

ShopDomainUpdate

Updates site domain of the shop.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopShop

Updated shop.

shopErrors[ShopError!]!

ShopError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeShopErrorCode!

The error code.

ShopFetchTaxRates

Fetch tax rates.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopShop

Updated shop.

shopErrors[ShopError!]!

ShopSettingsTranslate

Creates/Updates translations for Shop Settings.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopShop

Updated shop.

translationErrors[TranslationError!]!

ShopSettingsUpdate

Updates shop settings.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopShop

Updated shop.

shopErrors[ShopError!]!

ShopTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

headerTextString!
descriptionString!
languageLanguageDisplay!

Translation language.

StaffBulkDelete

Deletes staff users.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

staffErrors[StaffError!]!

StaffCreate

Creates a new staff user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

staffErrors[StaffError!]!
userUser

StaffDelete

Deletes a staff user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

staffErrors[StaffError!]!
userUser

StaffError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeAccountErrorCode!

The error code.

permissions[PermissionEnum!]

List of permissions which causes the error.

groups[ID!]

List of permission group IDs which cause the error.

users[ID!]

List of user IDs which causes the error.

StaffNotificationRecipient

Represents a recipient of email notifications send by Saleor, such as notifications about new orders. Notifications can be assigned to staff users or arbitrary email addresses.

FieldArgumentTypeDescription
userUser

Returns a user subscribed to email notifications.

activeBoolean

Determines if a notification active.

idID!

The ID of the object.

emailString

Returns email address of a user subscribed to email notifications.

StaffNotificationRecipientCreate

Creates a new staff notification recipient.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopErrors[ShopError!]!
staffNotificationRecipientStaffNotificationRecipient

StaffNotificationRecipientDelete

Delete staff notification recipient.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopErrors[ShopError!]!
staffNotificationRecipientStaffNotificationRecipient

StaffNotificationRecipientUpdate

Updates a staff notification recipient.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

shopErrors[ShopError!]!
staffNotificationRecipientStaffNotificationRecipient

StaffUpdate

Updates an existing staff user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

staffErrors[StaffError!]!
userUser

Stock

Represents stock.

FieldArgumentTypeDescription
warehouseWarehouse!
productVariantProductVariant!
quantityInt!

Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment.

idID!

The ID of the object.

quantityAllocatedInt!

Quantity allocated for orders

StockCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[StockCountableEdge!]!
totalCountInt

A total count of items in the collection.

StockCountableEdge

FieldArgumentTypeDescription
nodeStock!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

StockError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeStockErrorCode!

The error code.

TaxType

Representation of tax types fetched from tax gateway.

FieldArgumentTypeDescription
descriptionString

Description of the tax type.

taxCodeString

External tax code used to identify given tax group.

TaxedMoney

Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal.

FieldArgumentTypeDescription
currencyString!

Currency code.

grossMoney!

Amount of money including taxes.

netMoney!

Amount of money without taxes.

taxMoney!

Amount of taxes.

TaxedMoneyRange

Represents a range of monetary values.

FieldArgumentTypeDescription
startTaxedMoney

Lower bound of a price range.

stopTaxedMoney

Upper bound of a price range.

Transaction

An object representing a single payment.

FieldArgumentTypeDescription
idID!

The ID of the object.

createdDateTime!
paymentPayment!
tokenString!
kindTransactionKind!
isSuccessBoolean!
errorTransactionError
amountMoney

Total amount of the transaction.

TranslatableItemConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[TranslatableItemEdge!]!
totalCountInt

A total count of items in the collection.

TranslatableItemEdge

FieldArgumentTypeDescription
nodeTranslatableItem!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

TranslationError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeTranslationErrorCode!

The error code.

UpdateMetadata

Updates metadata of an object.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

metadataErrors[MetadataError!]!
itemObjectWithMetadata

UpdatePrivateMetadata

Updates private metadata of an object.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

metadataErrors[MetadataError!]!
itemObjectWithMetadata

User

Represents user data.

FieldArgumentTypeDescription
idID!

The ID of the object.

lastLoginDateTime
emailString!
firstNameString!
lastNameString!
isStaffBoolean!
isActiveBoolean!
noteString

A note about the customer.

dateJoinedDateTime!
defaultShippingAddressAddress
defaultBillingAddressAddress
privateMetadata[MetadataItem]!

List of private metadata items.Requires proper staff permissions to access.

metadata[MetadataItem]!

List of public metadata items. Can be accessed without permissions.

privateMeta ⚠️[MetaStore]!

List of privately stored metadata namespaces.

⚠️ DEPRECATED

Use the privetaMetadata field. This field will be removed after 2020-07-31.

meta ⚠️[MetaStore]!

List of publicly stored metadata namespaces.

⚠️ DEPRECATED

Use the metadata field. This field will be removed after 2020-07-31.

addresses[Address]

List of all user's addresses.

checkoutCheckout

Returns the last open checkout of this user.

giftCardsGiftCardCountableConnection

List of the user gift cards.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

ordersOrderCountableConnection

List of user's orders.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

permissions ⚠️[Permission]

List of user's permissions.

⚠️ DEPRECATED

Will be removed in Saleor 2.11.Use the userPermissions instead.

userPermissions[UserPermission]

List of user's permissions.

permissionGroups[Group]

List of user's permission groups.

editableGroups[Group]

List of user's permission groups which user can manage.

avatarImage
sizeInt

Size of the avatar.

events[CustomerEvent]

List of events associated with the user.

storedPaymentSources[PaymentSource]

List of stored payment sources.

UserAvatarDelete

Deletes a user avatar. Only for staff members.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

An updated user instance.

accountErrors[AccountError!]!

UserAvatarUpdate

Create a user avatar. Only for staff members. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

An updated user instance.

accountErrors[AccountError!]!

UserBulkSetActive

Activate or deactivate users.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

accountErrors[AccountError!]!

UserClearMeta

Clear metadata for user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

UserClearPrivateMeta

Clear private metadata for user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

UserCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[UserCountableEdge!]!
totalCountInt

A total count of items in the collection.

UserCountableEdge

FieldArgumentTypeDescription
nodeUser!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

UserPermission

FieldArgumentTypeDescription
codePermissionEnum!

Internal code for permission.

nameString!

Describe action(s) allowed to do by permission.

sourcePermissionGroups[Group!]

List of user permission groups which contains this permission.

userIdID!

ID of user whose groups should be returned.

UserUpdateMeta

Updates metadata for user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

UserUpdatePrivateMeta

Updates private metadata for user.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

accountErrors[AccountError!]!
userUser

VAT

Represents a VAT rate for a country.

FieldArgumentTypeDescription
countryCodeString!

Country code.

standardRateFloat

Standard VAT rate in percent.

reducedRates[ReducedRate]!

Country's VAT rate exceptions for specific types of goods.

VariantImageAssign

Assign an image to a product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productVariantProductVariant
imageProductImage
productErrors[ProductError!]!

VariantImageUnassign

Unassign an image from a product variant.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

productVariantProductVariant
imageProductImage
productErrors[ProductError!]!

VariantPricingInfo

Represents availability of a variant in the storefront.

FieldArgumentTypeDescription
onSaleBoolean

Whether it is in sale or not.

discountTaxedMoney

The discount amount if in sale (null otherwise).

discountLocalCurrencyTaxedMoney

The discount amount in the local currency.

priceTaxedMoney

The price, with any discount subtracted.

priceUndiscountedTaxedMoney

The price without any discount.

priceLocalCurrencyTaxedMoney

The discounted price in the local currency.

VerifyToken

Verify JWT token.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

userUser

User assigned to token.

isValidBoolean!

Determine if token is valid or not.

payloadGenericScalar

JWT payload.

accountErrors[AccountError!]!

Voucher

Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString
typeVoucherTypeEnum!

Determines a type of voucher.

codeString!
usageLimitInt
usedInt!
startDateDateTime!
endDateDateTime
applyOncePerOrderBoolean!
applyOncePerCustomerBoolean!
discountValueTypeDiscountValueTypeEnum!

Determines a type of discount for voucher - value or percentage

discountValueFloat!
minSpentMoney
minCheckoutItemsQuantityInt
categoriesCategoryCountableConnection

List of categories this voucher applies to.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

collectionsCollectionCountableConnection

List of collections this voucher applies to.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

productsProductCountableConnection

List of products this voucher applies to.

beforeString

Return the elements in the list that come before the specified cursor.

afterString

Return the elements in the list that come after the specified cursor.

firstInt

Return the first n elements from the list.

lastInt

Return the last n elements from the list.

countries[CountryDisplay]

List of countries available for the shipping voucher.

translationVoucherTranslation

Returns translated voucher fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for voucher.

VoucherAddCatalogues

Adds products, categories, collections to a voucher.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

voucherVoucher

Voucher of which catalogue IDs will be modified.

discountErrors[DiscountError!]!

VoucherBulkDelete

Deletes vouchers.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

countInt!

Returns how many objects were affected.

discountErrors[DiscountError!]!

VoucherCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[VoucherCountableEdge!]!
totalCountInt

A total count of items in the collection.

VoucherCountableEdge

FieldArgumentTypeDescription
nodeVoucher!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

VoucherCreate

Creates a new voucher.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

discountErrors[DiscountError!]!
voucherVoucher

VoucherDelete

Deletes a voucher.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

discountErrors[DiscountError!]!
voucherVoucher

VoucherRemoveCatalogues

Removes products, categories, collections from a voucher.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

voucherVoucher

Voucher of which catalogue IDs will be modified.

discountErrors[DiscountError!]!

VoucherTranslatableContent

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString
translationVoucherTranslation

Returns translated voucher fields for the given language code.

languageCodeLanguageCodeEnum!

A language code to return the translation for voucher.

voucherVoucher

Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.

VoucherTranslate

Creates/Updates translations for Voucher.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

translationErrors[TranslationError!]!
voucherVoucher

VoucherTranslation

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString
languageLanguageDisplay!

Translation language.

VoucherUpdate

Updates a voucher.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

discountErrors[DiscountError!]!
voucherVoucher

Warehouse

Represents warehouse.

FieldArgumentTypeDescription
idID!

The ID of the object.

nameString!
slugString!
companyNameString!
shippingZonesShippingZoneCountableConnection!
beforeString
afterString
firstInt
lastInt
addressAddress!
emailString!

WarehouseCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[WarehouseCountableEdge!]!
totalCountInt

A total count of items in the collection.

WarehouseCountableEdge

FieldArgumentTypeDescription
nodeWarehouse!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

WarehouseCreate

Creates new warehouse.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

warehouseErrors[WarehouseError!]!
warehouseWarehouse

WarehouseDelete

Deletes selected warehouse.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

warehouseErrors[WarehouseError!]!
warehouseWarehouse

WarehouseError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeWarehouseErrorCode!

The error code.

WarehouseShippingZoneAssign

Add shipping zone to given warehouse.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

warehouseErrors[WarehouseError!]!
warehouseWarehouse

WarehouseShippingZoneUnassign

Remove shipping zone from given warehouse.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

warehouseErrors[WarehouseError!]!
warehouseWarehouse

WarehouseUpdate

Updates given warehouse.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

warehouseErrors[WarehouseError!]!
warehouseWarehouse

Webhook

Webhook.

FieldArgumentTypeDescription
nameString!
targetUrlString!
isActiveBoolean!
secretKeyString
idID!

The ID of the object.

events[WebhookEvent!]!

List of webhook events.

serviceAccount ⚠️ServiceAccount!

⚠️ DEPRECATED

Use the app field instead. This field will be removed after 2020-07-31.

appApp!

WebhookCountableConnection

FieldArgumentTypeDescription
pageInfoPageInfo!

Pagination data for this connection.

edges[WebhookCountableEdge!]!
totalCountInt

A total count of items in the collection.

WebhookCountableEdge

FieldArgumentTypeDescription
nodeWebhook!

The item at the end of the edge.

cursorString!

A cursor for use in pagination.

WebhookCreate

Creates a new webhook subscription.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

webhookErrors[WebhookError!]!
webhookWebhook

WebhookDelete

Deletes a webhook subscription.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

webhookErrors[WebhookError!]!
webhookWebhook

WebhookError

FieldArgumentTypeDescription
fieldString

Name of a field that caused the error. A value of null indicates that the error isn't associated with a particular field.

messageString

The error message.

codeWebhookErrorCode!

The error code.

WebhookEvent

Webhook event.

FieldArgumentTypeDescription
eventTypeWebhookEventTypeEnum!

Internal name of the event type.

nameString!

Display name of the event.

WebhookUpdate

Updates a webhook subscription.

FieldArgumentTypeDescription
errors ⚠️[Error!]!

List of errors that occurred executing the mutation.

⚠️ DEPRECATED

Use typed errors with error codes. This field will be removed after 2020-07-31.

webhookErrors[WebhookError!]!
webhookWebhook

Weight

Represents weight value in a specific weight unit.

FieldArgumentTypeDescription
unitWeightUnitsEnum!

Weight unit.

valueFloat!

Weight value.

_Service

FieldArgumentTypeDescription
sdlString

Inputs

AccountInput

FieldTypeDescription
firstNameString

Given name.

lastNameString

Family name.

defaultBillingAddressAddressInput

Billing address of the customer.

defaultShippingAddressAddressInput

Shipping address of the customer.

AccountRegisterInput

FieldTypeDescription
emailString!

The email address of the user.

passwordString!

Password.

redirectUrlString

Base of frontend URL that will be needed to create confirmation URL.

AddressInput

FieldTypeDescription
firstNameString

Given name.

lastNameString

Family name.

companyNameString

Company or organization.

streetAddress1String

Address.

streetAddress2String

Address.

cityString

City.

cityAreaString

District.

postalCodeString

Postal code.

countryCountryCode

Country.

countryAreaString

State or province.

phoneString

Phone number.

AppFilterInput

FieldTypeDescription
searchString
isActiveBoolean
typeAppTypeEnum

AppInput

FieldTypeDescription
nameString

Name of the app.

isActiveBoolean

DEPRECATED: Use the appActivate and appDeactivate mutations instead. This field will be removed after 2020-07-31.

permissions[PermissionEnum]

List of permission code names to assign to this app.

AppInstallInput

FieldTypeDescription
appNameString

Name of the app to install.

manifestUrlString

Url to app's manifest in JSON format.

activateAfterInstallationBoolean

Determine if app will be set active or not.

permissions[PermissionEnum]

List of permission code names to assign to this app.

AppSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldAppSortField!

Sort apps by the selected field.

AppTokenInput

FieldTypeDescription
nameString

Name of the token.

appID!

ID of app.

AttributeAssignInput

FieldTypeDescription
idID!

The ID of the attribute to assign.

typeAttributeTypeEnum!

The attribute type to be assigned as.

AttributeCreateInput

FieldTypeDescription
inputTypeAttributeInputTypeEnum

The input type to use for entering attribute values in the dashboard.

nameString!

Name of an attribute displayed in the interface.

slugString

Internal representation of an attribute name.

values[AttributeValueCreateInput]

List of attribute's values.

valueRequiredBoolean

Whether the attribute requires values to be passed or not.

isVariantOnlyBoolean

Whether the attribute is for variants only.

visibleInStorefrontBoolean

Whether the attribute should be visible or not in storefront.

filterableInStorefrontBoolean

Whether the attribute can be filtered in storefront.

filterableInDashboardBoolean

Whether the attribute can be filtered in dashboard.

storefrontSearchPositionInt

The position of the attribute in the storefront navigation (0 by default).

availableInGridBoolean

Whether the attribute can be displayed in the admin product list.

AttributeFilterInput

FieldTypeDescription
valueRequiredBoolean
isVariantOnlyBoolean
visibleInStorefrontBoolean
filterableInStorefrontBoolean
filterableInDashboardBoolean
availableInGridBoolean
searchString
ids[ID]
inCollectionID
inCategoryID

AttributeInput

FieldTypeDescription
slugString!

Internal representation of an attribute name.

valueString

[Deprecated] Internal representation of a value (unique per attribute). This field will be removed after 2020-07-31.

values[String]

Internal representation of a value (unique per attribute).

AttributeSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldAttributeSortField!

Sort attributes by the selected field.

AttributeUpdateInput

FieldTypeDescription
nameString

Name of an attribute displayed in the interface.

slugString

Internal representation of an attribute name.

removeValues[ID]

IDs of values to be removed from this attribute.

addValues[AttributeValueCreateInput]

New values to be created for this attribute.

valueRequiredBoolean

Whether the attribute requires values to be passed or not.

isVariantOnlyBoolean

Whether the attribute is for variants only.

visibleInStorefrontBoolean

Whether the attribute should be visible or not in storefront.

filterableInStorefrontBoolean

Whether the attribute can be filtered in storefront.

filterableInDashboardBoolean

Whether the attribute can be filtered in dashboard.

storefrontSearchPositionInt

The position of the attribute in the storefront navigation (0 by default).

availableInGridBoolean

Whether the attribute can be displayed in the admin product list.

AttributeValueCreateInput

FieldTypeDescription
nameString!

Name of a value displayed in the interface.

AttributeValueInput

FieldTypeDescription
idID

ID of the selected attribute.

values[String]!

The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.

AuthorizationKeyInput

FieldTypeDescription
keyString!

Client authorization key (client ID).

passwordString!

Client secret.

CatalogueInput

FieldTypeDescription
products[ID]

Products related to the discount.

categories[ID]

Categories related to the discount.

collections[ID]

Collections related to the discount.

CategoryFilterInput

FieldTypeDescription
searchString
ids[ID]

CategoryInput

FieldTypeDescription
descriptionString

Category description (HTML/text).

descriptionJsonJSONString

Category description (JSON).

nameString

Category name.

slugString

Category slug.

seoSeoInput

Search engine optimization fields.

backgroundImageUpload

Background image file.

backgroundImageAltString

Alt text for an image.

CategorySortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldCategorySortField!

Sort categories by the selected field.

CheckoutCreateInput

FieldTypeDescription
lines[CheckoutLineInput]!

A list of checkout lines, each containing information about an item in the checkout.

emailString

The customer's email address.

shippingAddressAddressInput

The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items.

billingAddressAddressInput

Billing address of the customer.

CheckoutLineInput

FieldTypeDescription
quantityInt!

The number of items purchased.

variantIdID!

ID of the product variant.

CollectionCreateInput

FieldTypeDescription
isPublishedBoolean

Informs whether a collection is published.

nameString

Name of the collection.

slugString

Slug of the collection.

descriptionString

Description of the collection (HTML/text).

descriptionJsonJSONString

Description of the collection (JSON).

backgroundImageUpload

Background image file.

backgroundImageAltString

Alt text for an image.

seoSeoInput

Search engine optimization fields.

publicationDateDate

Publication date. ISO 8601 standard.

products[ID]

List of products to be added to the collection.

CollectionFilterInput

FieldTypeDescription
publishedCollectionPublished
searchString
ids[ID]

CollectionInput

FieldTypeDescription
isPublishedBoolean

Informs whether a collection is published.

nameString

Name of the collection.

slugString

Slug of the collection.

descriptionString

Description of the collection (HTML/text).

descriptionJsonJSONString

Description of the collection (JSON).

backgroundImageUpload

Background image file.

backgroundImageAltString

Alt text for an image.

seoSeoInput

Search engine optimization fields.

publicationDateDate

Publication date. ISO 8601 standard.

CollectionSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldCollectionSortField!

Sort collections by the selected field.

ConfigurationItemInput

FieldTypeDescription
nameString!

Name of the field to update.

valueString

Value of the given field to update.

CustomerFilterInput

FieldTypeDescription
dateJoinedDateRangeInput
moneySpentPriceRangeInput
numberOfOrdersIntRangeInput
placedOrdersDateRangeInput
searchString

CustomerInput

FieldTypeDescription
defaultBillingAddressAddressInput

Billing address of the customer.

defaultShippingAddressAddressInput

Shipping address of the customer.

firstNameString

Given name.

lastNameString

Family name.

emailString

The unique email address of the user.

isActiveBoolean

User account is active.

noteString

A note about the user.

DateRangeInput

FieldTypeDescription
gteDate

Start date.

lteDate

End date.

DateTimeRangeInput

FieldTypeDescription
gteDateTime

Start date.

lteDateTime

End date.

DigitalContentInput

FieldTypeDescription
useDefaultSettingsBoolean!

Use default digital content settings for this product.

maxDownloadsInt

Determines how many times a download link can be accessed by a customer.

urlValidDaysInt

Determines for how many days a download link is active since it was generated.

automaticFulfillmentBoolean

Overwrite default automatic_fulfillment setting for variant.

DigitalContentUploadInput

FieldTypeDescription
useDefaultSettingsBoolean!

Use default digital content settings for this product.

maxDownloadsInt

Determines how many times a download link can be accessed by a customer.

urlValidDaysInt

Determines for how many days a download link is active since it was generated.

automaticFulfillmentBoolean

Overwrite default automatic_fulfillment setting for variant.

contentFileUpload!

Represents an file in a multipart request.

DigitalContentUrlCreateInput

FieldTypeDescription
contentID!

Digital content ID which URL will belong to.

DraftOrderCreateInput

FieldTypeDescription
billingAddressAddressInput

Billing address of the customer.

userID
userEmailString

Email address of the customer.

discountPositiveDecimal

Discount amount for the order.

shippingAddressAddressInput

Shipping address of the customer.

shippingMethodID

ID of a selected shipping method.

voucherID

ID of the voucher associated with the order.

customerNoteString

A note from a customer. Visible by customers in the order summary.

lines[OrderLineCreateInput]

Variant line input consisting of variant ID and quantity of products.

DraftOrderInput

FieldTypeDescription
billingAddressAddressInput

Billing address of the customer.

userID
userEmailString

Email address of the customer.

discountPositiveDecimal

Discount amount for the order.

shippingAddressAddressInput

Shipping address of the customer.

shippingMethodID

ID of a selected shipping method.

voucherID

ID of the voucher associated with the order.

customerNoteString

A note from a customer. Visible by customers in the order summary.

ExportFileFilterInput

FieldTypeDescription
createdAtDateTimeRangeInput
updatedAtDateTimeRangeInput
statusJobStatusEnum
userString
appString

ExportFileSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldExportFileSortField!

Sort export file by the selected field.

ExportInfoInput

FieldTypeDescription
attributes[ID!]

List of attribute ids witch should be exported.

warehouses[ID!]

List of warehouse ids witch should be exported.

fields[ProductFieldEnum!]

List of product fields witch should be exported.

ExportProductsInput

FieldTypeDescription
scopeExportScope!

Determine which products should be exported.

filterProductFilterInput

Filtering options for products.

ids[ID!]

List of products IDS to export.

exportInfoExportInfoInput

Input with info about fields which should be exported.

fileTypeFileTypesEnum!

Type of exported file.

FulfillmentCancelInput

FieldTypeDescription
warehouseIdID!

ID of warehouse where items will be restock.

FulfillmentUpdateTrackingInput

FieldTypeDescription
trackingNumberString

Fulfillment tracking number.

notifyCustomerBoolean

If true, send an email notification to the customer.

GiftCardCreateInput

FieldTypeDescription
startDateDate

Start date of the gift card in ISO 8601 format.

endDateDate

End date of the gift card in ISO 8601 format.

balancePositiveDecimal

Value of the gift card.

userEmailString

The customer's email of the gift card buyer.

codeString

Code to use the gift card.

GiftCardUpdateInput

FieldTypeDescription
startDateDate

Start date of the gift card in ISO 8601 format.

endDateDate

End date of the gift card in ISO 8601 format.

balancePositiveDecimal

Value of the gift card.

userEmailString

The customer's email of the gift card buyer.

IntRangeInput

FieldTypeDescription
gteInt

Value greater than or equal to.

lteInt

Value less than or equal to.

InvoiceCreateInput

FieldTypeDescription
numberString!

Invoice number.

urlString!

URL of an invoice to download.

MenuCreateInput

FieldTypeDescription
nameString!

Name of the menu.

items[MenuItemInput]

List of menu items.

MenuFilterInput

FieldTypeDescription
searchString

MenuInput

FieldTypeDescription
nameString

Name of the menu.

MenuItemCreateInput

FieldTypeDescription
nameString!

Name of the menu item.

urlString

URL of the pointed item.

categoryID

Category to which item points.

collectionID

Collection to which item points.

pageID

Page to which item points.

menuID!

Menu to which item belongs.

parentID

ID of the parent menu. If empty, menu will be top level menu.

MenuItemFilterInput

FieldTypeDescription
searchString

MenuItemInput

FieldTypeDescription
nameString

Name of the menu item.

urlString

URL of the pointed item.

categoryID

Category to which item points.

collectionID

Collection to which item points.

pageID

Page to which item points.

MenuItemMoveInput

FieldTypeDescription
itemIdID!

The menu item ID to move.

parentIdID

ID of the parent menu. If empty, menu will be top level menu.

sortOrderInt

The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.

MenuItemSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldMenuItemsSortField!

Sort menu items by the selected field.

MenuSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldMenuSortField!

Sort menus by the selected field.

MetaInput

FieldTypeDescription
namespaceString!

Name of metadata client group.

clientNameString!

Metadata client's name.

keyString!

Key for stored data.

valueString!

Stored metadata value.

MetaPath

FieldTypeDescription
namespaceString!

Name of metadata client group.

clientNameString!

Metadata client's name.

keyString!

Key for stored data.

MetadataInput

FieldTypeDescription
keyString!

Key of a metadata item.

valueString!

Value of a metadata item.

MoveProductInput

FieldTypeDescription
productIdID!

The ID of the product to move.

sortOrderInt

The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.

NameTranslationInput

FieldTypeDescription
nameString

OrderAddNoteInput

FieldTypeDescription
messageString!

Note message.

OrderDraftFilterInput

FieldTypeDescription
customerString
createdDateRangeInput
searchString

OrderFilterInput

FieldTypeDescription
paymentStatus[PaymentChargeStatusEnum]
status[OrderStatusFilter]
customerString
createdDateRangeInput
searchString

OrderFulfillInput

FieldTypeDescription
lines[OrderFulfillLineInput!]!

List of items informing how to fulfill the order.

notifyCustomerBoolean

If true, send an email notification to the customer.

OrderFulfillLineInput

FieldTypeDescription
orderLineIdID

The ID of the order line.

stocks[OrderFulfillStockInput!]!

List of stock items to create.

OrderFulfillStockInput

FieldTypeDescription
quantityInt

The number of line items to be fulfilled from given warehouse.

warehouseID

ID of the warehouse from which the item will be fulfilled.

OrderLineCreateInput

FieldTypeDescription
quantityInt!

Number of variant items ordered.

variantIdID!

Product variant ID.

OrderLineInput

FieldTypeDescription
quantityInt!

Number of variant items ordered.

OrderSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldOrderSortField!

Sort orders by the selected field.

OrderUpdateInput

FieldTypeDescription
billingAddressAddressInput

Billing address of the customer.

userEmailString

Email address of the customer.

shippingAddressAddressInput

Shipping address of the customer.

OrderUpdateShippingInput

FieldTypeDescription
shippingMethodID

ID of the selected shipping method.

PageFilterInput

FieldTypeDescription
searchString

PageInput

FieldTypeDescription
slugString

Page internal name.

titleString

Page title.

contentString

Page content. May consist of ordinary text, HTML and images.

contentJsonJSONString

Page content in JSON format.

isPublishedBoolean

Determines if page is visible in the storefront.

publicationDateString

Publication date. ISO 8601 standard.

seoSeoInput

Search engine optimization fields.

PageSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldPageSortField!

Sort pages by the selected field.

PageTranslationInput

FieldTypeDescription
seoTitleString
seoDescriptionString
titleString
contentString
contentJsonJSONString

PaymentInput

FieldTypeDescription
gatewayString!

A gateway to use with that payment.

tokenString

Client-side generated payment token, representing customer's billing data in a secure manner.

amountPositiveDecimal

Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used.

billingAddressAddressInput

[Deprecated] Billing address. If empty, the billing address associated with the checkout instance will be used. Use checkoutCreate or checkoutBillingAddressUpdate mutations to set it. This field will be removed after 2020-07-31.

returnUrlString

URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided.

PermissionGroupCreateInput

FieldTypeDescription
addPermissions[PermissionEnum!]

List of permission code names to assign to this group.

addUsers[ID!]

List of users to assign to this group.

nameString!

Group name.

PermissionGroupFilterInput

FieldTypeDescription
searchString

PermissionGroupSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldPermissionGroupSortField!

Sort permission group by the selected field.

PermissionGroupUpdateInput

FieldTypeDescription
addPermissions[PermissionEnum!]

List of permission code names to assign to this group.

addUsers[ID!]

List of users to assign to this group.

nameString

Group name.

removePermissions[PermissionEnum!]

List of permission code names to unassign from this group.

removeUsers[ID!]

List of users to unassign from this group.

PluginFilterInput

FieldTypeDescription
activeBoolean
searchString

PluginSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldPluginSortField!

Sort plugins by the selected field.

PluginUpdateInput

FieldTypeDescription
activeBoolean

Indicates whether the plugin should be enabled.

configuration[ConfigurationItemInput]

Configuration of the plugin.

PriceRangeInput

FieldTypeDescription
gteFloat

Price greater than or equal to.

lteFloat

Price less than or equal to.

ProductCreateInput

FieldTypeDescription
attributes[AttributeValueInput]

List of attributes.

publicationDateDate

Publication date. ISO 8601 standard.

categoryID

ID of the product's category.

chargeTaxesBoolean

Determine if taxes are being charged for the product.

collections[ID]

List of IDs of collections that the product belongs to.

descriptionString

Product description (HTML/text).

descriptionJsonJSONString

Product description (JSON).

isPublishedBoolean

Determines if product is visible to customers.

nameString

Product name.

slugString

Product slug.

taxCodeString

Tax rate for enabled tax gateway.

seoSeoInput

Search engine optimization fields.

weightWeightScalar

Weight of the Product.

skuString

Stock keeping unit of a product. Note: this field is only used if a product doesn't use variants.

trackInventoryBoolean

Determines if the inventory of this product should be tracked. If false, the quantity won't change when customers buy this item. Note: this field is only used if a product doesn't use variants.

basePricePositiveDecimal

Default price for product variant. Note: this field is only used if a product doesn't use variants.

visibleInListingsBoolean

Determines if product is visible in product listings (doesn't apply to product collections).

productTypeID!

ID of the type that product belongs to.

stocks[StockInput!]

Stocks of a product available for sale. Note: this field is only used if a product doesn't use variants.

ProductFilterInput

FieldTypeDescription
isPublishedBoolean
collections[ID]
categories[ID]
hasCategoryBoolean
attributes[AttributeInput]
stockAvailabilityStockAvailability
productTypeID
stocksProductStockFilterInput
searchString
pricePriceRangeInput
minimalPricePriceRangeInput
productTypes[ID]

ProductImageCreateInput

FieldTypeDescription
altString

Alt text for an image.

imageUpload!

Represents an image file in a multipart request.

productID!

ID of an product.

ProductImageUpdateInput

FieldTypeDescription
altString

Alt text for an image.

ProductInput

FieldTypeDescription
attributes[AttributeValueInput]

List of attributes.

publicationDateDate

Publication date. ISO 8601 standard.

categoryID

ID of the product's category.

chargeTaxesBoolean

Determine if taxes are being charged for the product.

collections[ID]

List of IDs of collections that the product belongs to.

descriptionString

Product description (HTML/text).

descriptionJsonJSONString

Product description (JSON).

isPublishedBoolean

Determines if product is visible to customers.

nameString

Product name.

slugString

Product slug.

taxCodeString

Tax rate for enabled tax gateway.

seoSeoInput

Search engine optimization fields.

weightWeightScalar

Weight of the Product.

skuString

Stock keeping unit of a product. Note: this field is only used if a product doesn't use variants.

trackInventoryBoolean

Determines if the inventory of this product should be tracked. If false, the quantity won't change when customers buy this item. Note: this field is only used if a product doesn't use variants.

basePricePositiveDecimal

Default price for product variant. Note: this field is only used if a product doesn't use variants.

visibleInListingsBoolean

Determines if product is visible in product listings (doesn't apply to product collections).

ProductOrder

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

attributeIdID

Sort product by the selected attribute's values. Note: this doesn't take translations into account yet.

fieldProductOrderField

Sort products by the selected field.

ProductStockFilterInput

FieldTypeDescription
warehouseIds[ID!]
quantityIntRangeInput

ProductTypeFilterInput

FieldTypeDescription
searchString
configurableProductTypeConfigurable
productTypeProductTypeEnum
ids[ID]

ProductTypeInput

FieldTypeDescription
nameString

Name of the product type.

slugString

Product type slug.

hasVariantsBoolean

Determines if product of this type has multiple variants. This option mainly simplifies product management in the dashboard. There is always at least one variant created under the hood.

productAttributes[ID]

List of attributes shared among all product variants.

variantAttributes[ID]

List of attributes used to distinguish between different variants of a product.

isShippingRequiredBoolean

Determines if shipping is required for products of this variant.

isDigitalBoolean

Determines if products are digital.

weightWeightScalar

Weight of the ProductType items.

taxCodeString

Tax rate for enabled tax gateway.

ProductTypeSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldProductTypeSortField!

Sort product types by the selected field.

ProductVariantBulkCreateInput

FieldTypeDescription
attributes[AttributeValueInput]!

List of attributes specific to this variant.

costPricePositiveDecimal

Cost price of the variant.

pricePositiveDecimal

Price of the particular variant.

skuString!

Stock keeping unit.

trackInventoryBoolean

Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.

weightWeightScalar

Weight of the Product Variant.

stocks[StockInput!]

Stocks of a product available for sale.

ProductVariantCreateInput

FieldTypeDescription
attributes[AttributeValueInput]!

List of attributes specific to this variant.

costPricePositiveDecimal

Cost price of the variant.

pricePositiveDecimal

Price of the particular variant.

skuString

Stock keeping unit.

trackInventoryBoolean

Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.

weightWeightScalar

Weight of the Product Variant.

productID!

Product ID of which type is the variant.

stocks[StockInput!]

Stocks of a product available for sale.

ProductVariantInput

FieldTypeDescription
attributes[AttributeValueInput]

List of attributes specific to this variant.

costPricePositiveDecimal

Cost price of the variant.

pricePositiveDecimal

Price of the particular variant.

skuString

Stock keeping unit.

trackInventoryBoolean

Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.

weightWeightScalar

Weight of the Product Variant.

ReorderInput

FieldTypeDescription
idID!

The ID of the item to move.

sortOrderInt

The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.

SaleFilterInput

FieldTypeDescription
status[DiscountStatusEnum]
saleTypeDiscountValueTypeEnum
startedDateTimeRangeInput
searchString

SaleInput

FieldTypeDescription
nameString

Voucher name.

typeDiscountValueTypeEnum

Fixed or percentage.

valuePositiveDecimal

Value of the voucher.

products[ID]

Products related to the discount.

categories[ID]

Categories related to the discount.

collections[ID]

Collections related to the discount.

startDateDateTime

Start date of the voucher in ISO 8601 format.

endDateDateTime

End date of the voucher in ISO 8601 format.

SaleSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldSaleSortField!

Sort sales by the selected field.

SeoInput

FieldTypeDescription
titleString

SEO title.

descriptionString

SEO description.

ServiceAccountFilterInput

FieldTypeDescription
searchString
isActiveBoolean

ServiceAccountInput

FieldTypeDescription
nameString

Name of the service account.

isActiveBoolean

Determine if this service account should be enabled.

permissions[PermissionEnum]

List of permission code names to assign to this service account.

ServiceAccountSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldServiceAccountSortField!

Sort service accounts by the selected field.

ServiceAccountTokenInput

FieldTypeDescription
nameString

Name of the token.

serviceAccountID!

ID of service account.

ShippingPriceInput

FieldTypeDescription
nameString

Name of the shipping method.

pricePositiveDecimal

Shipping price of the shipping method.

minimumOrderPricePositiveDecimal

Minimum order price to use this shipping method.

maximumOrderPricePositiveDecimal

Maximum order price to use this shipping method.

minimumOrderWeightWeightScalar

Minimum order weight to use this shipping method.

maximumOrderWeightWeightScalar

Maximum order weight to use this shipping method.

typeShippingMethodTypeEnum

Shipping type: price or weight based.

shippingZoneID

Shipping zone this method belongs to.

ShippingZoneCreateInput

FieldTypeDescription
nameString

Shipping zone's name. Visible only to the staff.

countries[String]

List of countries in this shipping zone.

defaultBoolean

Default shipping zone will be used for countries not covered by other zones.

addWarehouses[ID]

List of warehouses to assign to a shipping zone

ShippingZoneUpdateInput

FieldTypeDescription
nameString

Shipping zone's name. Visible only to the staff.

countries[String]

List of countries in this shipping zone.

defaultBoolean

Default shipping zone will be used for countries not covered by other zones.

addWarehouses[ID]

List of warehouses to assign to a shipping zone

removeWarehouses[ID]

List of warehouses to unassign from a shipping zone

ShopSettingsInput

FieldTypeDescription
headerTextString

Header text.

descriptionString

SEO description.

includeTaxesInPricesBoolean

Include taxes in prices.

displayGrossPricesBoolean

Display prices with tax in store.

chargeTaxesOnShippingBoolean

Charge taxes on shipping.

trackInventoryByDefaultBoolean

Enable inventory tracking.

defaultWeightUnitWeightUnitsEnum

Default weight unit.

automaticFulfillmentDigitalProductsBoolean

Enable automatic fulfillment for all digital products.

defaultDigitalMaxDownloadsInt

Default number of max downloads per digital content URL.

defaultDigitalUrlValidDaysInt

Default number of days which digital content URL will be valid.

defaultMailSenderNameString

Default email sender's name.

defaultMailSenderAddressString

Default email sender's address.

customerSetPasswordUrlString

URL of a view where customers can set their password.

ShopSettingsTranslationInput

FieldTypeDescription
headerTextString
descriptionString

SiteDomainInput

FieldTypeDescription
domainString

Domain name for shop.

nameString

Shop site name.

StaffCreateInput

FieldTypeDescription
firstNameString

Given name.

lastNameString

Family name.

emailString

The unique email address of the user.

isActiveBoolean

User account is active.

noteString

A note about the user.

addGroups[ID!]

List of permission group IDs to which user should be assigned.

redirectUrlString

URL of a view where users should be redirected to set the password. URL in RFC 1808 format.

StaffNotificationRecipientInput

FieldTypeDescription
userID

The ID of the user subscribed to email notifications..

emailString

Email address of a user subscribed to email notifications.

activeBoolean

Determines if a notification active.

StaffUpdateInput

FieldTypeDescription
firstNameString

Given name.

lastNameString

Family name.

emailString

The unique email address of the user.

isActiveBoolean

User account is active.

noteString

A note about the user.

addGroups[ID!]

List of permission group IDs to which user should be assigned.

removeGroups[ID!]

List of permission group IDs from which user should be unassigned.

StaffUserInput

FieldTypeDescription
statusStaffMemberStatus
searchString

StockFilterInput

FieldTypeDescription
quantityFloat
searchString

StockInput

FieldTypeDescription
warehouseID!

Warehouse in which stock is located.

quantityInt

Quantity of items available for sell.

TranslationInput

FieldTypeDescription
seoTitleString
seoDescriptionString
nameString
descriptionString
descriptionJsonJSONString

UpdateInvoiceInput

FieldTypeDescription
numberString

Invoice number

urlString

URL of an invoice to download.

UserCreateInput

FieldTypeDescription
defaultBillingAddressAddressInput

Billing address of the customer.

defaultShippingAddressAddressInput

Shipping address of the customer.

firstNameString

Given name.

lastNameString

Family name.

emailString

The unique email address of the user.

isActiveBoolean

User account is active.

noteString

A note about the user.

redirectUrlString

URL of a view where users should be redirected to set the password. URL in RFC 1808 format.

UserSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldUserSortField!

Sort users by the selected field.

VoucherFilterInput

FieldTypeDescription
status[DiscountStatusEnum]
timesUsedIntRangeInput
discountType[VoucherDiscountType]
startedDateTimeRangeInput
searchString

VoucherInput

FieldTypeDescription
typeVoucherTypeEnum

Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER.

nameString

Voucher name.

codeString

Code to use the voucher.

startDateDateTime

Start date of the voucher in ISO 8601 format.

endDateDateTime

End date of the voucher in ISO 8601 format.

discountValueTypeDiscountValueTypeEnum

Choices: fixed or percentage.

discountValuePositiveDecimal

Value of the voucher.

products[ID]

Products discounted by the voucher.

collections[ID]

Collections discounted by the voucher.

categories[ID]

Categories discounted by the voucher.

minAmountSpentPositiveDecimal

Min purchase amount required to apply the voucher.

minCheckoutItemsQuantityInt

Minimal quantity of checkout items required to apply the voucher.

countries[String]

Country codes that can be used with the shipping voucher.

applyOncePerOrderBoolean

Voucher should be applied to the cheapest item or entire order.

applyOncePerCustomerBoolean

Voucher should be applied once per customer.

usageLimitInt

Limit number of times this voucher can be used in total.

VoucherSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldVoucherSortField!

Sort vouchers by the selected field.

WarehouseAddressInput

FieldTypeDescription
streetAddress1String!

Address.

streetAddress2String

Address.

cityString!

City.

cityAreaString

District.

postalCodeString

Postal code.

countryCountryCode!

Country.

countryAreaString

State or province.

phoneString

Phone number.

WarehouseCreateInput

FieldTypeDescription
slugString

Warehouse slug.

companyNameString

Company name.

emailString

The email address of the warehouse.

nameString!

Warehouse name.

addressWarehouseAddressInput!

Address of the warehouse.

shippingZones[ID]

Shipping zones supported by the warehouse.

WarehouseFilterInput

FieldTypeDescription
searchString
ids[ID]

WarehouseSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldWarehouseSortField!

Sort warehouses by the selected field.

WarehouseUpdateInput

FieldTypeDescription
slugString

Warehouse slug.

companyNameString

Company name.

emailString

The email address of the warehouse.

nameString

Warehouse name.

addressWarehouseAddressInput

Address of the warehouse.

WebhookCreateInput

FieldTypeDescription
nameString

The name of the webhook.

targetUrlString

The url to receive the payload.

events[WebhookEventTypeEnum]

The events that webhook wants to subscribe. The CHECKOUT_QUANTITY_CHANGED is depreacted. It will be removed in Saleor 3.0

serviceAccountID

DEPRECATED: Use the app field instead. This field will be removed after 2020-07-31.

appID

ID of the app to which webhook belongs.

isActiveBoolean

Determine if webhook will be set active or not.

secretKeyString

The secret key used to create a hash signature with each payload.

WebhookFilterInput

FieldTypeDescription
searchString
isActiveBoolean

WebhookSortingInput

FieldTypeDescription
directionOrderDirection!

Specifies the direction in which to sort products.

fieldWebhookSortField!

Sort webhooks by the selected field.

WebhookUpdateInput

FieldTypeDescription
nameString

The new name of the webhook.

targetUrlString

The url to receive the payload.

events[WebhookEventTypeEnum]

The events that webhook wants to subscribe. The CHECKOUT_QUANTITY_CHANGED is depreacted. It will be removed in Saleor 3.0

serviceAccountID

DEPRECATED: Use the app field instead. This field will be removed after 2020-07-31.

appID

ID of the app to which webhook belongs.

isActiveBoolean

Determine if webhook will be set active or not.

secretKeyString

Use to create a hash signature with each payload.

Enums

AccountErrorCode

An enumeration.

ValueDescription
ACTIVATE_OWN_ACCOUNT
ACTIVATE_SUPERUSER_ACCOUNT
DUPLICATED_INPUT_ITEM
DEACTIVATE_OWN_ACCOUNT
DEACTIVATE_SUPERUSER_ACCOUNT
DELETE_NON_STAFF_USER
DELETE_OWN_ACCOUNT
DELETE_STAFF_ACCOUNT
DELETE_SUPERUSER_ACCOUNT
GRAPHQL_ERROR
INVALID
INVALID_PASSWORD
LEFT_NOT_MANAGEABLE_PERMISSION
INVALID_CREDENTIALS
NOT_FOUND
OUT_OF_SCOPE_SERVICE_ACCOUNT
OUT_OF_SCOPE_USER
OUT_OF_SCOPE_GROUP
OUT_OF_SCOPE_PERMISSION
PASSWORD_ENTIRELY_NUMERIC
PASSWORD_TOO_COMMON
PASSWORD_TOO_SHORT
PASSWORD_TOO_SIMILAR
REQUIRED
UNIQUE
JWT_SIGNATURE_EXPIRED
JWT_INVALID_TOKEN
JWT_DECODE_ERROR
JWT_MISSING_TOKEN
JWT_INVALID_CSRF_TOKEN

AddressTypeEnum

An enumeration.

ValueDescription
BILLING
SHIPPING

AppErrorCode

An enumeration.

ValueDescription
FORBIDDEN
GRAPHQL_ERROR
INVALID
INVALID_STATUS
INVALID_PERMISSION
INVALID_URL_FORMAT
INVALID_MANIFEST_FORMAT
MANIFEST_URL_CANT_CONNECT
NOT_FOUND
REQUIRED
UNIQUE
OUT_OF_SCOPE_APP
OUT_OF_SCOPE_PERMISSION

AppSortField

ValueDescription
NAME

Sort apps by name.

CREATION_DATE

Sort apps by creation date.

AppTypeEnum

An enumeration.

ValueDescription
LOCAL
THIRDPARTY

AttributeInputTypeEnum

An enumeration.

ValueDescription
DROPDOWN
MULTISELECT

AttributeSortField

ValueDescription
NAME

Sort attributes by name

SLUG

Sort attributes by slug

VALUE_REQUIRED

Sort attributes by the value required flag

IS_VARIANT_ONLY

Sort attributes by the variant only flag

VISIBLE_IN_STOREFRONT

Sort attributes by visibility in the storefront

FILTERABLE_IN_STOREFRONT

Sort attributes by the filterable in storefront flag

FILTERABLE_IN_DASHBOARD

Sort attributes by the filterable in dashboard flag

STOREFRONT_SEARCH_POSITION

Sort attributes by their position in storefront

AVAILABLE_IN_GRID

Sort attributes based on whether they can be displayed or not in a product grid.

AttributeTypeEnum

ValueDescription
PRODUCT
VARIANT

AttributeValueType

ValueDescription
COLOR
GRADIENT
URL
STRING

AuthorizationKeyType

An enumeration.

ValueDescription
FACEBOOK
GOOGLE_OAUTH2

CategorySortField

ValueDescription
NAME

Sort categories by name.

PRODUCT_COUNT

Sort categories by product count.

SUBCATEGORY_COUNT

Sort categories by subcategory count.

CheckoutErrorCode

An enumeration.

ValueDescription
BILLING_ADDRESS_NOT_SET
CHECKOUT_NOT_FULLY_PAID
GRAPHQL_ERROR
PRODUCT_NOT_PUBLISHED
PRODUCT_UNAVAILABLE_FOR_PURCHASE
INSUFFICIENT_STOCK
INVALID
INVALID_SHIPPING_METHOD
NOT_FOUND
PAYMENT_ERROR
QUANTITY_GREATER_THAN_LIMIT
REQUIRED
SHIPPING_ADDRESS_NOT_SET
SHIPPING_METHOD_NOT_APPLICABLE
SHIPPING_METHOD_NOT_SET
SHIPPING_NOT_REQUIRED
TAX_ERROR
UNIQUE
VOUCHER_NOT_APPLICABLE
ZERO_QUANTITY

CollectionPublished

ValueDescription
PUBLISHED
HIDDEN

CollectionSortField

ValueDescription
NAME

Sort collections by name.

AVAILABILITY

Sort collections by availability.

PRODUCT_COUNT

Sort collections by product count.

ConfigurationTypeFieldEnum

An enumeration.

ValueDescription
STRING
BOOLEAN
SECRET
PASSWORD

CountryCode

An enumeration.

ValueDescription
AF
AX
AL
DZ
AS
AD
AO
AI
AQ
AG
AR
AM
AW
AU
AT
AZ
BS
BH
BD
BB
BY
BE
BZ
BJ
BM
BT
BO
BQ
BA
BW
BV
BR
IO
BN
BG
BF
BI
CV
KH
CM
CA
KY
CF
TD
CL
CN
CX
CC
CO
KM
CG
CD
CK
CR
CI
HR
CU
CW
CY
CZ
DK
DJ
DM
DO
EC
EG
SV
GQ
ER
EE
SZ
ET
EU
FK
FO
FJ
FI
FR
GF
PF
TF
GA
GM
GE
DE
GH
GI
GR
GL
GD
GP
GU
GT
GG
GN
GW
GY
HT
HM
VA
HN
HK
HU
IS
IN
ID
IR
IQ
IE
IM
IL
IT
JM
JP
JE
JO
KZ
KE
KI
KW
KG
LA
LV
LB
LS
LR
LY
LI
LT
LU
MO
MG
MW
MY
MV
ML
MT
MH
MQ
MR
MU
YT
MX
FM
MD
MC
MN
ME
MS
MA
MZ
MM
NA
NR
NP
NL
NC
NZ
NI
NE
NG
NU
NF
KP
MK
MP
NO
OM
PK
PW
PS
PA
PG
PY
PE
PH
PN
PL
PT
PR
QA
RE
RO
RU
RW
BL
SH
KN
LC
MF
PM
VC
WS
SM
ST
SA
SN
RS
SC
SL
SG
SX
SK
SI
SB
SO
ZA
GS
KR
SS
ES
LK
SD
SR
SJ
SE
CH
SY
TW
TJ
TZ
TH
TL
TG
TK
TO
TT
TN
TR
TM
TC
TV
UG
UA
AE
GB
UM
US
UY
UZ
VU
VE
VN
VG
VI
WF
EH
YE
ZM
ZW

CustomerEventsEnum

An enumeration.

ValueDescription
ACCOUNT_CREATED
PASSWORD_RESET_LINK_SENT
PASSWORD_RESET
EMAIL_CHANGED_REQUEST
PASSWORD_CHANGED
EMAIL_CHANGED
PLACED_ORDER
NOTE_ADDED_TO_ORDER
DIGITAL_LINK_DOWNLOADED
CUSTOMER_DELETED
NAME_ASSIGNED
EMAIL_ASSIGNED
NOTE_ADDED

DiscountErrorCode

An enumeration.

ValueDescription
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE

DiscountStatusEnum

ValueDescription
ACTIVE
EXPIRED
SCHEDULED

DiscountValueTypeEnum

ValueDescription
FIXED
PERCENTAGE

ExportErrorCode

An enumeration.

ValueDescription
INVALID
NOT_FOUND
REQUIRED

ExportEventsEnum

An enumeration.

ValueDescription
EXPORT_PENDING
EXPORT_SUCCESS
EXPORT_FAILED
EXPORT_DELETED
EXPORTED_FILE_SENT
EXPORT_FAILED_INFO_SENT

ExportFileSortField

ValueDescription
STATUS

Sort export file by status.

CREATED_AT

Sort export file by created at.

UPDATED_AT

Sort export file by updated at.

ExportScope

ValueDescription
ALL

Export all products.

IDS

Export products with given ids.

FILTER

Export the filtered products.

FileTypesEnum

An enumeration.

ValueDescription
CSV
XLSX

FulfillmentStatus

An enumeration.

ValueDescription
FULFILLED

Fulfilled

CANCELED

Canceled

GiftCardErrorCode

An enumeration.

ValueDescription
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE

InvoiceErrorCode

An enumeration.

ValueDescription
REQUIRED
NOT_READY
URL_NOT_SET
EMAIL_NOT_SET
NUMBER_NOT_SET
NOT_FOUND
INVALID_STATUS

JobStatusEnum

An enumeration.

ValueDescription
PENDING
SUCCESS
FAILED
DELETED

LanguageCodeEnum

An enumeration.

ValueDescription
AR
AZ
BG
BN
CA
CS
DA
DE
EL
EN
ES
ES_CO
ET
FA
FI
FR
HI
HU
HY
ID
IS
IT
JA
KM
KO
LT
MN
MY
NB
NL
PL
PT
PT_BR
RO
RU
SK
SL
SQ
SR
SV
SW
TA
TH
TR
UK
VI
ZH_HANS
ZH_HANT

MenuErrorCode

An enumeration.

ValueDescription
CANNOT_ASSIGN_NODE
GRAPHQL_ERROR
INVALID
INVALID_MENU_ITEM
NO_MENU_ITEM_PROVIDED
NOT_FOUND
REQUIRED
TOO_MANY_MENU_ITEMS
UNIQUE

MenuItemsSortField

ValueDescription
NAME

Sort menu items by name.

MenuSortField

ValueDescription
NAME

Sort menus by name.

ITEMS_COUNT

Sort menus by items count.

MetadataErrorCode

An enumeration.

ValueDescription
GRAPHQL_ERROR
INVALID
NOT_FOUND

NavigationType

ValueDescription
MAIN

Main storefront navigation.

SECONDARY

Secondary storefront navigation.

OrderAction

ValueDescription
CAPTURE

Represents the capture action.

MARK_AS_PAID

Represents a mark-as-paid action.

REFUND

Represents a refund action.

VOID

Represents a void action.

OrderDirection

ValueDescription
ASC

Specifies an ascending sort order.

DESC

Specifies a descending sort order.

OrderErrorCode

An enumeration.

ValueDescription
BILLING_ADDRESS_NOT_SET
CANNOT_CANCEL_FULFILLMENT
CANNOT_CANCEL_ORDER
CANNOT_DELETE
CANNOT_REFUND
CAPTURE_INACTIVE_PAYMENT
NOT_EDITABLE
FULFILL_ORDER_LINE
GRAPHQL_ERROR
INVALID
PRODUCT_NOT_PUBLISHED
PRODUCT_UNAVAILABLE_FOR_PURCHASE
NOT_FOUND
ORDER_NO_SHIPPING_ADDRESS
PAYMENT_ERROR
PAYMENT_MISSING
REQUIRED
SHIPPING_METHOD_NOT_APPLICABLE
SHIPPING_METHOD_REQUIRED
TAX_ERROR
UNIQUE
VOID_INACTIVE_PAYMENT
ZERO_QUANTITY
INSUFFICIENT_STOCK
DUPLICATED_INPUT_ITEM

OrderEventsEmailsEnum

An enumeration.

ValueDescription
PAYMENT_CONFIRMATION
SHIPPING_CONFIRMATION
TRACKING_UPDATED
ORDER_CONFIRMATION
ORDER_CANCEL
ORDER_REFUND
FULFILLMENT_CONFIRMATION
DIGITAL_LINKS

OrderEventsEnum

An enumeration.

ValueDescription
DRAFT_CREATED
DRAFT_ADDED_PRODUCTS
DRAFT_REMOVED_PRODUCTS
PLACED
PLACED_FROM_DRAFT
OVERSOLD_ITEMS
CANCELED
ORDER_MARKED_AS_PAID
ORDER_FULLY_PAID
UPDATED_ADDRESS
EMAIL_SENT
PAYMENT_AUTHORIZED
PAYMENT_CAPTURED
EXTERNAL_SERVICE_NOTIFICATION
PAYMENT_REFUNDED
PAYMENT_VOIDED
PAYMENT_FAILED
INVOICE_REQUESTED
INVOICE_GENERATED
INVOICE_UPDATED
INVOICE_SENT
FULFILLMENT_CANCELED
FULFILLMENT_RESTOCKED_ITEMS
FULFILLMENT_FULFILLED_ITEMS
TRACKING_UPDATED
NOTE_ADDED
OTHER

OrderSortField

ValueDescription
NUMBER

Sort orders by number.

CREATION_DATE

Sort orders by creation date.

CUSTOMER

Sort orders by customer.

PAYMENT

Sort orders by payment.

FULFILLMENT_STATUS

Sort orders by fulfillment status.

TOTAL

Sort orders by total.

OrderStatus

An enumeration.

ValueDescription
DRAFT

Draft

UNFULFILLED

Unfulfilled

PARTIALLY_FULFILLED

Partially fulfilled

FULFILLED

Fulfilled

CANCELED

Canceled

OrderStatusFilter

ValueDescription
READY_TO_FULFILL
READY_TO_CAPTURE
UNFULFILLED
PARTIALLY_FULFILLED
FULFILLED
CANCELED

PageErrorCode

An enumeration.

ValueDescription
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE

PageSortField

ValueDescription
TITLE

Sort pages by title.

SLUG

Sort pages by slug.

VISIBILITY

Sort pages by visibility.

CREATION_DATE

Sort pages by creation date.

PUBLICATION_DATE

Sort pages by publication date.

PaymentChargeStatusEnum

An enumeration.

ValueDescription
NOT_CHARGED
PENDING
PARTIALLY_CHARGED
FULLY_CHARGED
PARTIALLY_REFUNDED
FULLY_REFUNDED
REFUSED
CANCELLED

PaymentErrorCode

An enumeration.

ValueDescription
BILLING_ADDRESS_NOT_SET
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
PARTIAL_PAYMENT_NOT_ALLOWED
SHIPPING_ADDRESS_NOT_SET
INVALID_SHIPPING_METHOD
SHIPPING_METHOD_NOT_SET
PAYMENT_ERROR
NOT_SUPPORTED_GATEWAY

PermissionEnum

An enumeration.

ValueDescription
MANAGE_USERS
MANAGE_STAFF
MANAGE_SERVICE_ACCOUNTS
MANAGE_APPS
MANAGE_DISCOUNTS
MANAGE_PLUGINS
MANAGE_GIFT_CARD
MANAGE_MENUS
MANAGE_ORDERS
MANAGE_PAGES
MANAGE_PRODUCTS
MANAGE_SHIPPING
MANAGE_SETTINGS
MANAGE_TRANSLATIONS
MANAGE_CHECKOUTS

PermissionGroupErrorCode

An enumeration.

ValueDescription
ASSIGN_NON_STAFF_MEMBER
DUPLICATED_INPUT_ITEM
CANNOT_REMOVE_FROM_LAST_GROUP
LEFT_NOT_MANAGEABLE_PERMISSION
OUT_OF_SCOPE_PERMISSION
OUT_OF_SCOPE_USER
REQUIRED
UNIQUE

PermissionGroupSortField

ValueDescription
NAME

Sort permission group accounts by name.

PluginErrorCode

An enumeration.

ValueDescription
GRAPHQL_ERROR
INVALID
PLUGIN_MISCONFIGURED
NOT_FOUND
REQUIRED
UNIQUE

PluginSortField

ValueDescription
NAME
IS_ACTIVE

ProductErrorCode

An enumeration.

ValueDescription
ALREADY_EXISTS
ATTRIBUTE_ALREADY_ASSIGNED
ATTRIBUTE_CANNOT_BE_ASSIGNED
ATTRIBUTE_VARIANTS_DISABLED
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
NOT_PRODUCTS_IMAGE
NOT_PRODUCTS_VARIANT
NOT_FOUND
REQUIRED
UNIQUE
VARIANT_NO_DIGITAL_CONTENT

ProductFieldEnum

ValueDescription
NAME
DESCRIPTION
PRODUCT_TYPE
CATEGORY
VISIBLE
AVAILABLE_FOR_PURCHASE
SEARCHABLE
PRODUCT_WEIGHT
COLLECTIONS
CHARGE_TAXES
PRODUCT_IMAGES
VARIANT_SKU
VARIANT_PRICE
COST_PRICE
VARIANT_WEIGHT
VARIANT_IMAGES

ProductOrderField

ValueDescription
NAME

Sort products by name.

PRICE

Sort products by price.

MINIMAL_PRICE

Sort products by a minimal price of a product's variant.

DATE

Sort products by update date.

TYPE

Sort products by type.

PUBLISHED

Sort products by publication status.

ProductTypeConfigurable

ValueDescription
CONFIGURABLE
SIMPLE

ProductTypeEnum

ValueDescription
DIGITAL
SHIPPABLE

ProductTypeSortField

ValueDescription
NAME

Sort products by name.

DIGITAL

Sort products by type.

SHIPPING_REQUIRED

Sort products by shipping.

ReportingPeriod

ValueDescription
TODAY
THIS_MONTH

SaleSortField

ValueDescription
NAME

Sort sales by name.

START_DATE

Sort sales by start date.

END_DATE

Sort sales by end date.

VALUE

Sort sales by value.

TYPE

Sort sales by type.

SaleType

An enumeration.

ValueDescription
FIXED

USD

PERCENTAGE

%

ServiceAccountSortField

ValueDescription
NAME

Sort service accounts by name.

CREATION_DATE

Sort service accounts by creation date.

ShippingErrorCode

An enumeration.

ValueDescription
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
MAX_LESS_THAN_MIN
NOT_FOUND
REQUIRED
UNIQUE
DUPLICATED_INPUT_ITEM

ShippingMethodTypeEnum

An enumeration.

ValueDescription
PRICE
WEIGHT

ShopErrorCode

An enumeration.

ValueDescription
ALREADY_EXISTS
CANNOT_FETCH_TAX_RATES
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE

StaffMemberStatus

ValueDescription
ACTIVE
DEACTIVATED

StockAvailability

ValueDescription
IN_STOCK
OUT_OF_STOCK

StockErrorCode

An enumeration.

ValueDescription
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE

TaxRateType

An enumeration.

ValueDescription
ACCOMMODATION
ADMISSION_TO_CULTURAL_EVENTS
ADMISSION_TO_ENTERTAINMENT_EVENTS
ADMISSION_TO_SPORTING_EVENTS
ADVERTISING
AGRICULTURAL_SUPPLIES
BABY_FOODSTUFFS
BIKES
BOOKS
CHILDRENS_CLOTHING
DOMESTIC_FUEL
DOMESTIC_SERVICES
E_BOOKS
FOODSTUFFS
HOTELS
MEDICAL
NEWSPAPERS
PASSENGER_TRANSPORT
PHARMACEUTICALS
PROPERTY_RENOVATIONS
RESTAURANTS
SOCIAL_HOUSING
STANDARD
WATER
WINE

TransactionError

An enumeration.

ValueDescription
TRANSACTIONERROR_INCORRECT_NUMBER

incorrect_number

TRANSACTIONERROR_INVALID_NUMBER

invalid_number

TRANSACTIONERROR_INCORRECT_CVV

incorrect_cvv

TRANSACTIONERROR_INVALID_CVV

invalid_cvv

TRANSACTIONERROR_INCORRECT_ZIP

incorrect_zip

TRANSACTIONERROR_INCORRECT_ADDRESS

incorrect_address

TRANSACTIONERROR_INVALID_EXPIRY_DATE

invalid_expiry_date

TRANSACTIONERROR_EXPIRED

expired

TRANSACTIONERROR_PROCESSING_ERROR

processing_error

TRANSACTIONERROR_DECLINED

declined

TransactionKind

An enumeration.

ValueDescription
AUTH

Authorization

PENDING

Pending

ACTION_TO_CONFIRM

Action to confirm

REFUND

Refund

REFUND_ONGOING

Refund in progress

CAPTURE

Capture

VOID

Void

CONFIRM

Confirm

CANCEL

Cancel

TranslatableKinds

ValueDescription
ATTRIBUTE
ATTRIBUTE_VALUE
CATEGORY
COLLECTION
MENU_ITEM
PAGE
PRODUCT
SALE
SHIPPING_METHOD
VARIANT
VOUCHER

TranslationErrorCode

An enumeration.

ValueDescription
GRAPHQL_ERROR
NOT_FOUND
REQUIRED

UserSortField

ValueDescription
FIRST_NAME

Sort users by first name.

LAST_NAME

Sort users by last name.

EMAIL

Sort users by email.

ORDER_COUNT

Sort users by order count.

VoucherDiscountType

ValueDescription
FIXED
PERCENTAGE
SHIPPING

VoucherSortField

ValueDescription
CODE

Sort vouchers by code.

START_DATE

Sort vouchers by start date.

END_DATE

Sort vouchers by end date.

VALUE

Sort vouchers by value.

TYPE

Sort vouchers by type.

</