crowetic/commerce
1
0
Fork 1
mirror of https://github.com/vercel/commerce.git synced 2025-06-20 22:11:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
commerce/framework/saleor/schema.graphql

20407 lines
347 KiB
GraphQL
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

type Query {
"""
Look up a webhook by ID.
"""
webhook(
"""
ID of the webhook.
"""
id: ID!
): Webhook
"""
List of all available webhook events.
"""
webhookEvents: [WebhookEvent]
"""
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.
"""
webhookSamplePayload(
"""
Name of the requested event type.
"""
eventType: WebhookSampleEventTypeEnum!
): JSONString
"""
Look up a warehouse by ID.
"""
warehouse(
"""
ID of an warehouse
"""
id: ID!
): Warehouse
"""
List of warehouses.
"""
warehouses(
filter: WarehouseFilterInput
sortBy: WarehouseSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): WarehouseCountableConnection
"""
Returns a list of all translatable items of a given kind.
"""
translations(
"""
Kind of objects to retrieve.
"""
kind: TranslatableKinds!
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): TranslatableItemConnection
translation(
"""
ID of the object to retrieve.
"""
id: ID!
"""
Kind of the object to retrieve.
"""
kind: TranslatableKinds!
): TranslatableItem
"""
Look up a stock by ID
"""
stock(
"""
ID of an warehouse
"""
id: ID!
): Stock
"""
List of stocks.
"""
stocks(
filter: StockFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): StockCountableConnection
"""
Return information about the shop.
"""
shop: Shop!
"""
Order related settings from site settings.
"""
orderSettings: OrderSettings
"""
Look up a shipping zone by ID.
"""
shippingZone(
"""
ID of the shipping zone.
"""
id: ID!
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): ShippingZone
"""
List of the shop's shipping zones.
"""
shippingZones(
"""
Filtering options for shipping zones.
"""
filter: ShippingZoneFilterInput
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ShippingZoneCountableConnection
"""
Look up digital content by ID.
"""
digitalContent(
"""
ID of the digital content.
"""
id: ID!
): DigitalContent
"""
List of digital content.
"""
digitalContents(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): DigitalContentCountableConnection
"""
List of the shop's categories.
"""
categories(
"""
Filtering options for categories.
"""
filter: CategoryFilterInput
"""
Sort categories.
"""
sortBy: CategorySortingInput
"""
Filter categories by the nesting level in the category tree.
"""
level: Int
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CategoryCountableConnection
"""
Look up a category by ID or slug.
"""
category(
"""
ID of the category.
"""
id: ID
"""
Slug of the category
"""
slug: String
): Category
"""
Look up a collection by ID.
"""
collection(
"""
ID of the collection.
"""
id: ID
"""
Slug of the category
"""
slug: String
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): Collection
"""
List of the shop's collections.
"""
collections(
"""
Filtering options for collections.
"""
filter: CollectionFilterInput
"""
Sort collections.
"""
sortBy: CollectionSortingInput
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CollectionCountableConnection
"""
Look up a product by ID.
"""
product(
"""
ID of the product.
"""
id: ID
"""
Slug of the product.
"""
slug: String
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): Product
"""
List of the shop's products.
"""
products(
"""
Filtering options for products.
"""
filter: ProductFilterInput
"""
Sort products.
"""
sortBy: ProductOrder
"""
[Deprecated] Filter products by stock availability. Use the `filter` field instead. This field will be removed after 2020-07-31.
"""
stockAvailability: StockAvailability
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductCountableConnection
"""
Look up a product type by ID.
"""
productType(
"""
ID of the product type.
"""
id: ID!
): ProductType
"""
List of the shop's product types.
"""
productTypes(
"""
Filtering options for product types.
"""
filter: ProductTypeFilterInput
"""
Sort product types.
"""
sortBy: ProductTypeSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductTypeCountableConnection
"""
Look up a product variant by ID or SKU.
"""
productVariant(
"""
ID of the product variant.
"""
id: ID
"""
Sku of the product variant.
"""
sku: String
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): ProductVariant
"""
List of product variants.
"""
productVariants(
"""
Filter product variants by given IDs.
"""
ids: [ID]
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Filtering options for product variant.
"""
filter: ProductVariantFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductVariantCountableConnection
"""
List of top selling products.
"""
reportProductSales(
"""
Span of time.
"""
period: ReportingPeriod!
"""
Slug of a channel for which the data should be returned.
"""
channel: String!
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductVariantCountableConnection
"""
Look up a payment by ID.
"""
payment(
"""
ID of the payment.
"""
id: ID!
): Payment
"""
List of payments.
"""
payments(
"""
Filtering options for payments.
"""
filter: PaymentFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): PaymentCountableConnection
"""
Look up a page by ID or slug.
"""
page(
"""
ID of the page.
"""
id: ID
"""
The slug of the page.
"""
slug: String
): Page
"""
List of the shop's pages.
"""
pages(
"""
Sort pages.
"""
sortBy: PageSortingInput
"""
Filtering options for pages.
"""
filter: PageFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): PageCountableConnection
"""
Look up a page type by ID.
"""
pageType(
"""
ID of the page type.
"""
id: ID!
): PageType
"""
List of the page types.
"""
pageTypes(
"""
Sort page types.
"""
sortBy: PageTypeSortingInput
"""
Filtering options for page types.
"""
filter: PageTypeFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): PageTypeCountableConnection
"""
List of activity events to display on homepage (at the moment it only contains order-events).
"""
homepageEvents(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): OrderEventCountableConnection
"""
Look up an order by ID.
"""
order(
"""
ID of an order.
"""
id: ID!
): Order
"""
List of orders.
"""
orders(
"""
Sort orders.
"""
sortBy: OrderSortingInput
"""
Filtering options for orders.
"""
filter: OrderFilterInput
"""
[Deprecated] Filter orders from a selected timespan. Use the `filter` field instead. This field will be removed after 2020-07-31.
"""
created: ReportingPeriod
"""
[Deprecated] Filter order by status. Use the `filter` field instead. This field will be removed after 2020-07-31.
"""
status: OrderStatusFilter
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): OrderCountableConnection
"""
List of draft orders.
"""
draftOrders(
"""
Sort draft orders.
"""
sortBy: OrderSortingInput
"""
Filtering options for draft orders.
"""
filter: OrderDraftFilterInput
"""
[Deprecated] Filter draft orders from a selected timespan. Use the `filter` field instead. This field will be removed after 2020-07-31.
"""
created: ReportingPeriod
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): OrderCountableConnection
"""
Return the total sales amount from a specific period.
"""
ordersTotal(
"""
A period of time.
"""
period: ReportingPeriod
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): TaxedMoney
"""
Look up an order by token.
"""
orderByToken(
"""
The order's token.
"""
token: UUID!
): Order
"""
Look up a navigation menu by ID or name.
"""
menu(
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
ID of the menu.
"""
id: ID
"""
The menu's name.
"""
name: String
"""
The menu's slug.
"""
slug: String
): Menu
"""
List of the storefront's menus.
"""
menus(
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Sort menus.
"""
sortBy: MenuSortingInput
"""
Filtering options for menus.
"""
filter: MenuFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): MenuCountableConnection
"""
Look up a menu item by ID.
"""
menuItem(
"""
ID of the menu item.
"""
id: ID!
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): MenuItem
"""
List of the storefronts's menu items.
"""
menuItems(
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Sort menus items.
"""
sortBy: MenuItemSortingInput
"""
Filtering options for menu items.
"""
filter: MenuItemFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): MenuItemCountableConnection
"""
Look up a gift card by ID.
"""
giftCard(
"""
ID of the gift card.
"""
id: ID!
): GiftCard
"""
List of gift cards.
"""
giftCards(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): GiftCardCountableConnection
"""
Look up a plugin by ID.
"""
plugin(
"""
ID of the plugin.
"""
id: ID!
): Plugin
"""
List of plugins.
"""
plugins(
"""
Filtering options for plugins.
"""
filter: PluginFilterInput
"""
Sort plugins.
"""
sortBy: PluginSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): PluginCountableConnection
"""
Look up a sale by ID.
"""
sale(
"""
ID of the sale.
"""
id: ID!
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): Sale
"""
List of the shop's sales.
"""
sales(
"""
Filtering options for sales.
"""
filter: SaleFilterInput
"""
Sort sales.
"""
sortBy: SaleSortingInput
"""
Search sales by name, value or type.
"""
query: String
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): SaleCountableConnection
"""
Look up a voucher by ID.
"""
voucher(
"""
ID of the voucher.
"""
id: ID!
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): Voucher
"""
List of the shop's vouchers.
"""
vouchers(
"""
Filtering options for vouchers.
"""
filter: VoucherFilterInput
"""
Sort voucher.
"""
sortBy: VoucherSortingInput
"""
Search vouchers by name or code.
"""
query: String
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): VoucherCountableConnection
"""
Look up a export file by ID.
"""
exportFile(
"""
ID of the export file job.
"""
id: ID!
): ExportFile
"""
List of export files.
"""
exportFiles(
"""
Filtering options for export files.
"""
filter: ExportFileFilterInput
"""
Sort export files.
"""
sortBy: ExportFileSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ExportFileCountableConnection
"""
List of all tax rates available from tax gateway.
"""
taxTypes: [TaxType]
"""
Look up a checkout by token and slug of channel.
"""
checkout(
"""
The checkout's token.
"""
token: UUID
): Checkout
"""
List of checkouts.
"""
checkouts(
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CheckoutCountableConnection
"""
Look up a checkout line by ID.
"""
checkoutLine(
"""
ID of the checkout line.
"""
id: ID
): CheckoutLine
"""
List of checkout lines.
"""
checkoutLines(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CheckoutLineCountableConnection
"""
Look up a channel by ID.
"""
channel(
"""
ID of the channel.
"""
id: ID
): Channel
"""
List of all channels.
"""
channels: [Channel!]
"""
List of the shop's attributes.
"""
attributes(
"""
Filtering options for attributes.
"""
filter: AttributeFilterInput
"""
Sorting options for attributes.
"""
sortBy: AttributeSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): AttributeCountableConnection
"""
Look up an attribute by ID.
"""
attribute(
"""
ID of the attribute.
"""
id: ID
"""
Slug of the attribute.
"""
slug: String
): Attribute
"""
List of all apps installations
"""
appsInstallations: [AppInstallation!]!
"""
List of the apps.
"""
apps(
"""
Filtering options for apps.
"""
filter: AppFilterInput
"""
Sort apps.
"""
sortBy: AppSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): AppCountableConnection
"""
Look up an app by ID. If ID is not provided, return the currently authenticated app.
"""
app(
"""
ID of the app.
"""
id: ID
): App
"""
Returns address validation rules.
"""
addressValidationRules(
"""
Two-letter ISO 3166-1 country code.
"""
countryCode: CountryCode!
"""
Designation of a region, province or state.
"""
countryArea: String
"""
City or a town name.
"""
city: String
"""
Sublocality like a district.
"""
cityArea: String
): AddressValidationData
"""
Look up an address by ID.
"""
address(
"""
ID of an address.
"""
id: ID!
): Address
"""
List of the shop's customers.
"""
customers(
"""
Filtering options for customers.
"""
filter: CustomerFilterInput
"""
Sort customers.
"""
sortBy: UserSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): UserCountableConnection
"""
List of permission groups.
"""
permissionGroups(
"""
Filtering options for permission groups.
"""
filter: PermissionGroupFilterInput
"""
Sort permission groups.
"""
sortBy: PermissionGroupSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): GroupCountableConnection
"""
Look up permission group by ID.
"""
permissionGroup(
"""
ID of the group.
"""
id: ID!
): Group
"""
Return the currently authenticated user.
"""
me: User
"""
List of the shop's staff users.
"""
staffUsers(
"""
Filtering options for staff users.
"""
filter: StaffUserInput
"""
Sort staff users.
"""
sortBy: UserSortingInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): UserCountableConnection
"""
Look up a user by ID or email address.
"""
user(
"""
ID of the user.
"""
id: ID
"""
Email address of the user.
"""
email: String
): User
_entities(representations: [_Any]): [_Entity]
_service: _Service
}
"""
Webhook.
"""
type Webhook implements Node {
name: String!
targetUrl: String!
isActive: Boolean!
secretKey: String
"""
The ID of the object.
"""
id: ID!
"""
List of webhook events.
"""
events: [WebhookEvent!]!
app: App!
}
"""
An object with an ID
"""
interface Node {
"""
The ID of the object.
"""
id: ID!
}
"""
Webhook event.
"""
type WebhookEvent {
"""
Internal name of the event type.
"""
eventType: WebhookEventTypeEnum!
"""
Display name of the event.
"""
name: String!
}
"""
Enum determining type of webhook.
"""
enum WebhookEventTypeEnum {
"""
All the events.
"""
ANY_EVENTS
"""
A new order is placed.
"""
ORDER_CREATED
"""
An order is confirmed (status change unconfirmed -> unfulfilled) by a staff user using the OrderConfirm mutation. It also triggers when the user completes the checkout and the shop setting `automatically_confirm_all_new_orders` is enabled.
"""
ORDER_CONFIRMED
"""
Payment is made and an order is fully paid.
"""
ORDER_FULLY_PAID
"""
An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED.
"""
ORDER_UPDATED
"""
An order is cancelled.
"""
ORDER_CANCELLED
"""
An order is fulfilled.
"""
ORDER_FULFILLED
"""
An invoice for order requested.
"""
INVOICE_REQUESTED
"""
An invoice is deleted.
"""
INVOICE_DELETED
"""
Invoice has been sent.
"""
INVOICE_SENT
"""
A new customer account is created.
"""
CUSTOMER_CREATED
"""
A customer account is updated.
"""
CUSTOMER_UPDATED
"""
A new product is created.
"""
PRODUCT_CREATED
"""
A product is updated.
"""
PRODUCT_UPDATED
"""
A product is deleted.
"""
PRODUCT_DELETED
"""
A new product variant is created.
"""
PRODUCT_VARIANT_CREATED
"""
A product variant is updated.
"""
PRODUCT_VARIANT_UPDATED
"""
A product variant is deleted.
"""
PRODUCT_VARIANT_DELETED
"""
A new checkout is created.
"""
CHECKOUT_CREATED
"""
A checkout is updated. It also triggers all updates related to the checkout.
"""
CHECKOUT_UPDATED
"""
A new fulfillment is created.
"""
FULFILLMENT_CREATED
"""
User notification triggered.
"""
NOTIFY_USER
"""
A new page is created.
"""
PAGE_CREATED
"""
A page is updated.
"""
PAGE_UPDATED
"""
A page is deleted.
"""
PAGE_DELETED
}
"""
Represents app data.
"""
type App implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
"""
Name of the app.
"""
name: String
"""
The date and time when the app was created.
"""
created: DateTime
"""
Determine if app will be set active or not.
"""
isActive: Boolean
"""
List of the app's permissions.
"""
permissions: [Permission]
"""
Last 4 characters of the tokens.
"""
tokens: [AppToken]
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Type of the app.
"""
type: AppTypeEnum
"""
List of webhooks assigned to this app.
"""
webhooks: [Webhook]
"""
Description of this app.
"""
aboutApp: String
"""
Description of the data privacy defined for this app.
"""
dataPrivacy: String
"""
Url to details about the privacy policy on the app owner page.
"""
dataPrivacyUrl: String
"""
Homepage of the app.
"""
homepageUrl: String
"""
Support page for the app.
"""
supportUrl: String
"""
Url to iframe with the configuration for the app.
"""
configurationUrl: String
"""
Url to iframe with the app.
"""
appUrl: String
"""
Version number of the app.
"""
version: String
"""
JWT token used to authenticate by thridparty app.
"""
accessToken: String
}
interface ObjectWithMetadata {
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
}
type MetadataItem {
"""
Key of a metadata item.
"""
key: String!
"""
Value of a metadata item.
"""
value: String!
}
"""
The `DateTime` scalar type represents a DateTime
value as specified by
[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
"""
scalar DateTime
"""
Represents a permission object in a friendly form.
"""
type Permission {
"""
Internal code for permission.
"""
code: PermissionEnum!
"""
Describe action(s) allowed to do by permission.
"""
name: String!
}
"""
An enumeration.
"""
enum PermissionEnum {
MANAGE_USERS
MANAGE_STAFF
MANAGE_APPS
MANAGE_CHANNELS
MANAGE_DISCOUNTS
MANAGE_PLUGINS
MANAGE_GIFT_CARD
MANAGE_MENUS
MANAGE_ORDERS
MANAGE_PAGES
MANAGE_PAGE_TYPES_AND_ATTRIBUTES
MANAGE_PRODUCTS
MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES
MANAGE_SHIPPING
MANAGE_SETTINGS
MANAGE_TRANSLATIONS
MANAGE_CHECKOUTS
}
"""
Represents token data.
"""
type AppToken implements Node {
"""
Name of the authenticated token.
"""
name: String
"""
Last 4 characters of the token.
"""
authToken: String
"""
The ID of the object.
"""
id: ID!
}
"""
Enum determining type of your App.
"""
enum AppTypeEnum {
"""
Local Saleor App. The app is fully manageable from dashboard. You can change assigned permissions, add webhooks, or authentication token
"""
LOCAL
"""
Third party external App. Installation is fully automated. Saleor uses a defined App manifest to gather all required information.
"""
THIRDPARTY
}
"""
Allows use of a JSON String for input / output from the GraphQL schema.
Use of this type is *not recommended* as you lose the benefits of having a defined, static
schema (one of the key benefits of GraphQL).
"""
scalar JSONString
"""
An enumeration.
"""
enum WebhookSampleEventTypeEnum {
ORDER_CREATED
ORDER_CONFIRMED
ORDER_FULLY_PAID
ORDER_UPDATED
ORDER_CANCELLED
ORDER_FULFILLED
INVOICE_REQUESTED
INVOICE_DELETED
INVOICE_SENT
CUSTOMER_CREATED
CUSTOMER_UPDATED
PRODUCT_CREATED
PRODUCT_UPDATED
PRODUCT_DELETED
PRODUCT_VARIANT_CREATED
PRODUCT_VARIANT_UPDATED
PRODUCT_VARIANT_DELETED
CHECKOUT_CREATED
CHECKOUT_UPDATED
FULFILLMENT_CREATED
NOTIFY_USER
PAGE_CREATED
PAGE_UPDATED
PAGE_DELETED
}
"""
Represents warehouse.
"""
type Warehouse implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
slug: String!
companyName: String!
shippingZones(
before: String
after: String
first: Int
last: Int
): ShippingZoneCountableConnection!
address: Address!
email: String!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
}
type ShippingZoneCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [ShippingZoneCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
"""
The Relay compliant `PageInfo` type, containing data necessary to paginate this connection.
"""
type PageInfo {
"""
When paginating forwards, are there more items?
"""
hasNextPage: Boolean!
"""
When paginating backwards, are there more items?
"""
hasPreviousPage: Boolean!
"""
When paginating backwards, the cursor to continue.
"""
startCursor: String
"""
When paginating forwards, the cursor to continue.
"""
endCursor: String
}
type ShippingZoneCountableEdge {
"""
The item at the end of the edge.
"""
node: ShippingZone!
"""
A cursor for use in pagination.
"""
cursor: String!
}
"""
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.
"""
type ShippingZone implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
default: Boolean!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Lowest and highest prices for the shipping.
"""
priceRange: MoneyRange
"""
List of countries available for the method.
"""
countries: [CountryDisplay]
"""
List of shipping methods available for orders shipped to countries within this shipping zone.
"""
shippingMethods: [ShippingMethod]
"""
List of warehouses for shipping zone.
"""
warehouses: [Warehouse!]!
"""
List of channels for shipping zone.
"""
channels: [Channel!]!
"""
Description of a shipping zone.
"""
description: String
}
"""
Represents a range of amounts of money.
"""
type MoneyRange {
"""
Lower bound of a price range.
"""
start: Money
"""
Upper bound of a price range.
"""
stop: Money
}
"""
Represents amount of money in specific currency.
"""
type Money {
"""
Currency code.
"""
currency: String!
"""
Amount of money.
"""
amount: Float!
"""
Money formatted according to the current locale.
"""
localized: String!
@deprecated(
reason: "Price formatting according to the current locale should be handled by the frontend client. This field will be removed after 2020-07-31."
)
}
type CountryDisplay {
"""
Country code.
"""
code: String!
"""
Country name.
"""
country: String!
"""
Country tax.
"""
vat: VAT
}
"""
Represents a VAT rate for a country.
"""
type VAT {
"""
Country code.
"""
countryCode: String!
"""
Standard VAT rate in percent.
"""
standardRate: Float
"""
Country's VAT rate exceptions for specific types of goods.
"""
reducedRates: [ReducedRate]!
}
"""
Represents a reduced VAT rate for a particular type of goods.
"""
type ReducedRate {
"""
Reduced VAT rate in percent.
"""
rate: Float!
"""
A type of goods.
"""
rateType: TaxRateType!
}
"""
An enumeration.
"""
enum TaxRateType {
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
}
"""
Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.
"""
type ShippingMethod implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
minimumOrderWeight: Weight
maximumOrderWeight: Weight
maximumDeliveryDays: Int
minimumDeliveryDays: Int
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Type of the shipping method.
"""
type: ShippingMethodTypeEnum
"""
Returns translated shipping method fields for the given language code.
"""
translation(
"""
A language code to return the translation for shipping method.
"""
languageCode: LanguageCodeEnum!
): ShippingMethodTranslation
"""
List of channels available for the method.
"""
channelListings: [ShippingMethodChannelListing!]
"""
The price of the cheapest variant (including discounts).
"""
price: Money
"""
The price of the cheapest variant (including discounts).
"""
maximumOrderPrice: Money
"""
The price of the cheapest variant (including discounts).
"""
minimumOrderPrice: Money
"""
Postal code ranges rule of exclusion or inclusion of the shipping method.
"""
postalCodeRules: [ShippingMethodPostalCodeRule]
"""
List of excluded products for the shipping method.
"""
excludedProducts(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductCountableConnection
}
"""
Represents weight value in a specific weight unit.
"""
type Weight {
"""
Weight unit.
"""
unit: WeightUnitsEnum!
"""
Weight value.
"""
value: Float!
}
"""
An enumeration.
"""
enum WeightUnitsEnum {
KG
LB
OZ
G
}
"""
An enumeration.
"""
enum ShippingMethodTypeEnum {
PRICE
WEIGHT
}
type ShippingMethodTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
name: String
description: JSONString
"""
Translation language.
"""
language: LanguageDisplay!
}
type LanguageDisplay {
"""
ISO 639 representation of the language name.
"""
code: LanguageCodeEnum!
"""
Full name of the language.
"""
language: String!
}
"""
An enumeration.
"""
enum LanguageCodeEnum {
AR
AZ
BG
BN
CA
CS
DA
DE
EL
EN
ES
ES_CO
ET
FA
FI
FR
HI
HU
HY
ID
IS
IT
JA
KA
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
}
"""
Represents shipping method channel listing.
"""
type ShippingMethodChannelListing implements Node {
"""
The ID of the object.
"""
id: ID!
channel: Channel!
minimumOrderPrice: Money
maximumOrderPrice: Money
price: Money
}
"""
Represents channel.
"""
type Channel implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
isActive: Boolean!
slug: String!
currencyCode: String!
"""
Whether a channel has associated orders.
"""
hasOrders: Boolean!
"""
List of channel shipping zones.
"""
shippingZones: [ShippingZone!]!
}
"""
Represents shipping method postal code rule.
"""
type ShippingMethodPostalCodeRule implements Node {
"""
Start address range.
"""
start: String
"""
End address range.
"""
end: String
"""
Inclusion type of the postal code rule.
"""
inclusionType: PostalCodeRuleInclusionTypeEnum
"""
The ID of the object.
"""
id: ID!
}
"""
An enumeration.
"""
enum PostalCodeRuleInclusionTypeEnum {
INCLUDE
EXCLUDE
}
type ProductCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [ProductCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type ProductCountableEdge {
"""
The item at the end of the edge.
"""
node: Product!
"""
A cursor for use in pagination.
"""
cursor: String!
}
"""
Represents an individual item for sale in the storefront.
"""
type Product implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
seoTitle: String
seoDescription: String
name: String!
description: JSONString
productType: ProductType!
slug: String!
category: Category
updatedAt: DateTime
chargeTaxes: Boolean!
weight: Weight
defaultVariant: ProductVariant
rating: Float
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Description of the product (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
"""
The storefront URL for the product.
"""
url: String!
@deprecated(reason: "This field will be removed after 2020-07-31.")
"""
The main thumbnail for a product.
"""
thumbnail(
"""
Size of thumbnail.
"""
size: Int
): Image
"""
Lists the storefront product's pricing, the current price and discounts, only meant for displaying.
"""
pricing(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): ProductPricingInfo
"""
Whether the product is in stock and visible or not.
"""
isAvailable(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): Boolean
"""
A type of tax. Assigned by enabled tax gateway
"""
taxType: TaxType
"""
List of attributes assigned to this product.
"""
attributes: [SelectedAttribute!]!
"""
List of availability in channels for the product.
"""
channelListings: [ProductChannelListing!]
"""
Get a single product media by ID.
"""
mediaById(
"""
ID of a product media.
"""
id: ID
): ProductMedia!
"""
Get a single product image by ID.
"""
imageById(
"""
ID of a product image.
"""
id: ID
): ProductImage
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `mediaById` field instead."
)
"""
List of variants for the product.
"""
variants: [ProductVariant]
"""
List of media for the product.
"""
media: [ProductMedia!]
"""
List of images for the product.
"""
images: [ProductImage]
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `media` field instead."
)
"""
List of collections for the product.
"""
collections: [Collection]
"""
Returns translated product fields for the given language code.
"""
translation(
"""
A language code to return the translation for product.
"""
languageCode: LanguageCodeEnum!
): ProductTranslation
"""
Date when product is available for purchase.
"""
availableForPurchase: Date
"""
Whether the product is available for purchase.
"""
isAvailableForPurchase: Boolean
}
"""
Represents a type of product. It defines what attributes are available to products of this type.
"""
type ProductType implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
slug: String!
hasVariants: Boolean!
isShippingRequired: Boolean!
isDigital: Boolean!
weight: Weight
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
List of products of this type.
"""
products(
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductCountableConnection
@deprecated(
reason: "Use the top-level `products` query with the `productTypes` filter."
)
"""
A type of tax. Assigned by enabled tax gateway
"""
taxType: TaxType
"""
Variant attributes of that product type.
"""
variantAttributes(
"""
Define scope of returned attributes.
"""
variantSelection: VariantAttributeScope
): [Attribute]
"""
Product attributes of that product type.
"""
productAttributes: [Attribute]
availableAttributes(
filter: AttributeFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): AttributeCountableConnection
}
"""
Representation of tax types fetched from tax gateway.
"""
type TaxType {
"""
Description of the tax type.
"""
description: String
"""
External tax code used to identify given tax group.
"""
taxCode: String
}
"""
Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.
"""
type Attribute implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
productTypes(
before: String
after: String
first: Int
last: Int
): ProductTypeCountableConnection!
productVariantTypes(
before: String
after: String
first: Int
last: Int
): ProductTypeCountableConnection!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
The input type to use for entering attribute values in the dashboard.
"""
inputType: AttributeInputTypeEnum
"""
The entity type which can be used as a reference.
"""
entityType: AttributeEntityTypeEnum
"""
Name of an attribute displayed in the interface.
"""
name: String
"""
Internal representation of an attribute name.
"""
slug: String
"""
The attribute type.
"""
type: AttributeTypeEnum
"""
List of attribute's values.
"""
values: [AttributeValue]
"""
Whether the attribute requires values to be passed or not.
"""
valueRequired: Boolean!
"""
Whether the attribute should be visible or not in storefront.
"""
visibleInStorefront: Boolean!
"""
Whether the attribute can be filtered in storefront.
"""
filterableInStorefront: Boolean!
"""
Whether the attribute can be filtered in dashboard.
"""
filterableInDashboard: Boolean!
"""
Whether the attribute can be displayed in the admin product list.
"""
availableInGrid: Boolean!
"""
Returns translated attribute fields for the given language code.
"""
translation(
"""
A language code to return the translation for attribute.
"""
languageCode: LanguageCodeEnum!
): AttributeTranslation
"""
The position of the attribute in the storefront navigation (0 by default).
"""
storefrontSearchPosition: Int!
}
type ProductTypeCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [ProductTypeCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type ProductTypeCountableEdge {
"""
The item at the end of the edge.
"""
node: ProductType!
"""
A cursor for use in pagination.
"""
cursor: String!
}
"""
An enumeration.
"""
enum AttributeInputTypeEnum {
DROPDOWN
MULTISELECT
FILE
REFERENCE
RICH_TEXT
}
"""
An enumeration.
"""
enum AttributeEntityTypeEnum {
PAGE
PRODUCT
}
"""
An enumeration.
"""
enum AttributeTypeEnum {
PRODUCT_TYPE
PAGE_TYPE
}
"""
Represents a value of an attribute.
"""
type AttributeValue implements Node {
"""
The ID of the object.
"""
id: ID!
"""
Name of a value displayed in the interface.
"""
name: String
"""
Internal representation of a value (unique per attribute).
"""
slug: String
"""
Represents the value of the attribute value.
"""
value: String
"""
Returns translated attribute value fields for the given language code.
"""
translation(
"""
A language code to return the translation for attribute value.
"""
languageCode: LanguageCodeEnum!
): AttributeValueTranslation
"""
The input type to use for entering attribute values in the dashboard.
"""
inputType: AttributeInputTypeEnum
"""
The ID of the attribute reference.
"""
reference: ID
"""
Represents file URL and content type (if attribute value is a file).
"""
file: File
"""
Represents the text (JSON) of the attribute value.
"""
richText: JSONString
}
type AttributeValueTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
richText: JSONString
"""
Translation language.
"""
language: LanguageDisplay!
}
type File {
"""
The URL of the file.
"""
url: String!
"""
Content type of the file.
"""
contentType: String
}
type AttributeTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Translation language.
"""
language: LanguageDisplay!
}
enum VariantAttributeScope {
ALL
VARIANT_SELECTION
NOT_VARIANT_SELECTION
}
type AttributeCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [AttributeCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type AttributeCountableEdge {
"""
The item at the end of the edge.
"""
node: Attribute!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input AttributeFilterInput {
valueRequired: Boolean
isVariantOnly: Boolean
visibleInStorefront: Boolean
filterableInStorefront: Boolean
filterableInDashboard: Boolean
availableInGrid: Boolean
metadata: [MetadataInput]
search: String
ids: [ID]
type: AttributeTypeEnum
inCollection: ID
inCategory: ID
"""
Specifies the channel by which the data should be sorted.
"""
channel: String
}
input MetadataInput {
"""
Key of a metadata item.
"""
key: String!
"""
Value of a metadata item.
"""
value: String!
}
"""
Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront.
"""
type Category implements Node & ObjectWithMetadata {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
slug: String!
parent: Category
level: Int!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Description of the category (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
"""
List of ancestors of the category.
"""
ancestors(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CategoryCountableConnection
"""
List of products in the category.
"""
products(
"""
Slug of a channel for which the data should be returned.
"""
channel: String
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductCountableConnection
"""
The storefront's URL for the category.
"""
url: String
@deprecated(reason: "This field will be removed after 2020-07-31.")
"""
List of children of the category.
"""
children(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CategoryCountableConnection
backgroundImage(
"""
Size of the image.
"""
size: Int
): Image
"""
Returns translated category fields for the given language code.
"""
translation(
"""
A language code to return the translation for category.
"""
languageCode: LanguageCodeEnum!
): CategoryTranslation
}
type CategoryCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [CategoryCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type CategoryCountableEdge {
"""
The item at the end of the edge.
"""
node: Category!
"""
A cursor for use in pagination.
"""
cursor: String!
}
"""
Represents an image.
"""
type Image {
"""
The URL of the image.
"""
url: String!
"""
Alt text for an image.
"""
alt: String
}
type CategoryTranslation implements Node {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
"""
Translation language.
"""
language: LanguageDisplay!
"""
Translated description of the product (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
}
"""
Represents a version of a product such as different size or color.
"""
type ProductVariant implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
sku: String!
product: Product!
trackInventory: Boolean!
weight: Weight
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
List of price information in channels for the product.
"""
channelListings: [ProductVariantChannelListing!]
"""
Lists the storefront variant's pricing, the current price and discounts, only meant for displaying.
"""
pricing(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): VariantPricingInfo
"""
List of attributes assigned to this variant.
"""
attributes(
"""
Define scope of returned attributes.
"""
variantSelection: VariantAttributeScope
): [SelectedAttribute!]!
"""
Cost price of the variant.
"""
costPrice: Money
"""
Gross margin percentage value.
"""
margin: Int
"""
Total quantity ordered.
"""
quantityOrdered: Int
"""
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.
"""
revenue(period: ReportingPeriod): TaxedMoney
"""
List of images for the product variant.
"""
images: [ProductImage]
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `media` instead."
)
"""
List of media for the product variant.
"""
media: [ProductMedia!]
"""
Returns translated product variant fields for the given language code.
"""
translation(
"""
A language code to return the translation for product variant.
"""
languageCode: LanguageCodeEnum!
): ProductVariantTranslation
"""
Digital content for the product variant.
"""
digitalContent: DigitalContent
"""
Stocks for the product variant.
"""
stocks(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
"""
DEPRECATED: use `address` argument instead. This argument will be removed in Saleor 4.0. Two-letter ISO 3166-1 country code.
"""
countryCode: CountryCode
): [Stock]
"""
Quantity of a product available for sale in one checkout.
"""
quantityAvailable(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
"""
DEPRECATED: use `address` argument instead. This argument will be removed in Saleor 4.0.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.
"""
countryCode: CountryCode
): Int!
}
"""
Represents product varaint channel listing.
"""
type ProductVariantChannelListing implements Node {
"""
The ID of the object.
"""
id: ID!
channel: Channel!
price: Money
"""
Cost price of the variant.
"""
costPrice: Money
"""
Gross margin percentage value.
"""
margin: Int
}
"""
Represents availability of a variant in the storefront.
"""
type VariantPricingInfo {
"""
Whether it is in sale or not.
"""
onSale: Boolean
"""
The discount amount if in sale (null otherwise).
"""
discount: TaxedMoney
"""
The discount amount in the local currency.
"""
discountLocalCurrency: TaxedMoney
"""
The price, with any discount subtracted.
"""
price: TaxedMoney
"""
The price without any discount.
"""
priceUndiscounted: TaxedMoney
"""
The discounted price in the local currency.
"""
priceLocalCurrency: TaxedMoney
}
"""
Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal.
"""
type TaxedMoney {
"""
Currency code.
"""
currency: String!
"""
Amount of money including taxes.
"""
gross: Money!
"""
Amount of money without taxes.
"""
net: Money!
"""
Amount of taxes.
"""
tax: Money!
}
input AddressInput {
"""
Given name.
"""
firstName: String
"""
Family name.
"""
lastName: String
"""
Company or organization.
"""
companyName: String
"""
Address.
"""
streetAddress1: String
"""
Address.
"""
streetAddress2: String
"""
City.
"""
city: String
"""
District.
"""
cityArea: String
"""
Postal code.
"""
postalCode: String
"""
Country.
"""
country: CountryCode
"""
State or province.
"""
countryArea: String
"""
Phone number.
"""
phone: String
}
"""
An enumeration.
"""
enum CountryCode {
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
}
"""
Represents a custom attribute.
"""
type SelectedAttribute {
"""
Name of an attribute displayed in the interface.
"""
attribute: Attribute!
"""
Values of an attribute.
"""
values: [AttributeValue]!
}
enum ReportingPeriod {
TODAY
THIS_MONTH
}
"""
Represents a product image.
"""
type ProductImage {
"""
The ID of the image.
"""
id: ID!
"""
The alt text of the image.
"""
alt: String
"""
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.
"""
sortOrder: Int
"""
The URL of the image.
"""
url(
"""
Size of the image.
"""
size: Int
): String!
}
"""
Represents a product media.
"""
type ProductMedia implements Node {
"""
The ID of the object.
"""
id: ID!
sortOrder: Int
alt: String!
type: ProductMediaType!
oembedData: JSONString!
"""
The URL of the media.
"""
url(
"""
Size of the image.
"""
size: Int
): String!
}
"""
An enumeration.
"""
enum ProductMediaType {
"""
An uploaded image or an URL to an image
"""
IMAGE
"""
A URL to an external video
"""
VIDEO
}
type ProductVariantTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Translation language.
"""
language: LanguageDisplay!
}
type DigitalContent implements Node & ObjectWithMetadata {
useDefaultSettings: Boolean!
automaticFulfillment: Boolean!
contentFile: String!
maxDownloads: Int
urlValidDays: Int
"""
List of URLs for the digital variant.
"""
urls: [DigitalContentUrl]
"""
The ID of the object.
"""
id: ID!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Product variant assigned to digital content.
"""
productVariant: ProductVariant!
}
type DigitalContentUrl implements Node {
content: DigitalContent!
created: DateTime!
downloadNum: Int!
"""
The ID of the object.
"""
id: ID!
"""
URL for digital content.
"""
url: String
"""
UUID of digital content.
"""
token: UUID!
}
scalar UUID
"""
Represents stock.
"""
type Stock implements Node {
warehouse: Warehouse!
productVariant: ProductVariant!
"""
Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment.
"""
quantity: Int!
"""
The ID of the object.
"""
id: ID!
"""
Quantity allocated for orders
"""
quantityAllocated: Int!
}
"""
Represents availability of a product in the storefront.
"""
type ProductPricingInfo {
"""
Whether it is in sale or not.
"""
onSale: Boolean
"""
The discount amount if in sale (null otherwise).
"""
discount: TaxedMoney
"""
The discount amount in the local currency.
"""
discountLocalCurrency: TaxedMoney
"""
The discounted price range of the product variants.
"""
priceRange: TaxedMoneyRange
"""
The undiscounted price range of the product variants.
"""
priceRangeUndiscounted: TaxedMoneyRange
"""
The discounted price range of the product variants in the local currency.
"""
priceRangeLocalCurrency: TaxedMoneyRange
}
"""
Represents a range of monetary values.
"""
type TaxedMoneyRange {
"""
Lower bound of a price range.
"""
start: TaxedMoney
"""
Upper bound of a price range.
"""
stop: TaxedMoney
}
"""
Represents product channel listing.
"""
type ProductChannelListing implements Node {
"""
The ID of the object.
"""
id: ID!
publicationDate: Date
isPublished: Boolean!
channel: Channel!
visibleInListings: Boolean!
availableForPurchase: Date
"""
The price of the cheapest variant (including discounts).
"""
discountedPrice: Money
"""
Purchase cost of product.
"""
purchaseCost: MoneyRange
"""
Range of margin percentage value.
"""
margin: Margin
"""
Whether the product is available for purchase.
"""
isAvailableForPurchase: Boolean
"""
Lists the storefront product's pricing, the current price and discounts, only meant for displaying.
"""
pricing(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): ProductPricingInfo
}
"""
The `Date` scalar type represents a Date
value as specified by
[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
"""
scalar Date
type Margin {
start: Int
stop: Int
}
"""
Represents a collection of products.
"""
type Collection implements Node & ObjectWithMetadata {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
slug: String!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Description of the collection (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
"""
List of products in this collection.
"""
products(
"""
Filtering options for products.
"""
filter: ProductFilterInput
"""
Sort products.
"""
sortBy: ProductOrder
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductCountableConnection
backgroundImage(
"""
Size of the image.
"""
size: Int
): Image
"""
Returns translated collection fields for the given language code.
"""
translation(
"""
A language code to return the translation for collection.
"""
languageCode: LanguageCodeEnum!
): CollectionTranslation
"""
List of channels in which the collection is available.
"""
channelListings: [CollectionChannelListing!]
}
input ProductFilterInput {
isPublished: Boolean
collections: [ID]
categories: [ID]
hasCategory: Boolean
attributes: [AttributeInput]
stockAvailability: StockAvailability
productType: ID
stocks: ProductStockFilterInput
search: String
metadata: [MetadataInput]
price: PriceRangeInput
minimalPrice: PriceRangeInput
productTypes: [ID]
ids: [ID]
"""
Specifies the channel by which the data should be sorted.
"""
channel: String
}
input AttributeInput {
"""
Internal representation of an attribute name.
"""
slug: String!
"""
[Deprecated] Internal representation of a value (unique per attribute). This field will be removed after 2020-07-31.
"""
value: String
"""
Internal representation of a value (unique per attribute).
"""
values: [String]
}
enum StockAvailability {
IN_STOCK
OUT_OF_STOCK
}
input ProductStockFilterInput {
warehouseIds: [ID!]
quantity: IntRangeInput
}
input IntRangeInput {
"""
Value greater than or equal to.
"""
gte: Int
"""
Value less than or equal to.
"""
lte: Int
}
input PriceRangeInput {
"""
Price greater than or equal to.
"""
gte: Float
"""
Price less than or equal to.
"""
lte: Float
}
input ProductOrder {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
"""
channel: String
"""
Sort product by the selected attribute's values.
Note: this doesn't take translations into account yet.
"""
attributeId: ID
"""
Sort products by the selected field.
"""
field: ProductOrderField
}
enum OrderDirection {
"""
Specifies an ascending sort order.
"""
ASC
"""
Specifies a descending sort order.
"""
DESC
}
enum ProductOrderField {
"""
Sort products by name.
"""
NAME
"""
Sort products by rank. Note: This option is available only with the `search` filter.
"""
RANK
"""
Sort products by price.
"""
PRICE
"""
Sort products by a minimal price of a product's variant.
"""
MINIMAL_PRICE
"""
Sort products by update date.
"""
DATE
"""
Sort products by type.
"""
TYPE
"""
Sort products by publication status.
"""
PUBLISHED
"""
Sort products by publication date.
"""
PUBLICATION_DATE
"""
Sort products by collection. Note: This option is available only for the `Collection.products` query.
"""
COLLECTION
"""
Sort products by rating.
"""
RATING
}
type CollectionTranslation implements Node {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
"""
Translation language.
"""
language: LanguageDisplay!
"""
Translated description of the product (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
}
"""
Represents collection channel listing.
"""
type CollectionChannelListing implements Node {
publicationDate: Date
isPublished: Boolean!
"""
The ID of the object.
"""
id: ID!
channel: Channel!
}
type ProductTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
seoTitle: String
seoDescription: String
name: String!
description: JSONString
"""
Translation language.
"""
language: LanguageDisplay!
"""
Translated description of the product (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
}
"""
Represents user address data.
"""
type Address implements Node {
"""
The ID of the object.
"""
id: ID!
firstName: String!
lastName: String!
companyName: String!
streetAddress1: String!
streetAddress2: String!
city: String!
cityArea: String!
postalCode: String!
"""
Shop's default country.
"""
country: CountryDisplay!
countryArea: String!
phone: String
"""
Address is user's default shipping address.
"""
isDefaultShippingAddress: Boolean
"""
Address is user's default billing address.
"""
isDefaultBillingAddress: Boolean
}
type WarehouseCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [WarehouseCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type WarehouseCountableEdge {
"""
The item at the end of the edge.
"""
node: Warehouse!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input WarehouseFilterInput {
search: String
ids: [ID]
}
input WarehouseSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort warehouses by the selected field.
"""
field: WarehouseSortField!
}
enum WarehouseSortField {
"""
Sort warehouses by name.
"""
NAME
}
type TranslatableItemConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [TranslatableItemEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type TranslatableItemEdge {
"""
The item at the end of the edge.
"""
node: TranslatableItem!
"""
A cursor for use in pagination.
"""
cursor: String!
}
union TranslatableItem =
ProductTranslatableContent
| CollectionTranslatableContent
| CategoryTranslatableContent
| AttributeTranslatableContent
| AttributeValueTranslatableContent
| ProductVariantTranslatableContent
| PageTranslatableContent
| ShippingMethodTranslatableContent
| SaleTranslatableContent
| VoucherTranslatableContent
| MenuItemTranslatableContent
type ProductTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
seoTitle: String
seoDescription: String
name: String!
description: JSONString
"""
Description of the product (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
"""
Returns translated product fields for the given language code.
"""
translation(
"""
A language code to return the translation for product.
"""
languageCode: LanguageCodeEnum!
): ProductTranslation
"""
Represents an individual item for sale in the storefront.
"""
product: Product
}
type CollectionTranslatableContent implements Node {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
"""
Description of the collection (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
"""
Returns translated collection fields for the given language code.
"""
translation(
"""
A language code to return the translation for collection.
"""
languageCode: LanguageCodeEnum!
): CollectionTranslation
"""
Represents a collection of products.
"""
collection: Collection
}
type CategoryTranslatableContent implements Node {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
"""
Description of the category (JSON).
"""
descriptionJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `description` field instead."
)
"""
Returns translated category fields for the given language code.
"""
translation(
"""
A language code to return the translation for category.
"""
languageCode: LanguageCodeEnum!
): CategoryTranslation
"""
Represents a single category of products.
"""
category: Category
}
type AttributeTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Returns translated attribute fields for the given language code.
"""
translation(
"""
A language code to return the translation for attribute.
"""
languageCode: LanguageCodeEnum!
): AttributeTranslation
"""
Custom attribute of a product.
"""
attribute: Attribute
}
type AttributeValueTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Returns translated attribute value fields for the given language code.
"""
translation(
"""
A language code to return the translation for attribute value.
"""
languageCode: LanguageCodeEnum!
): AttributeValueTranslation
"""
Represents a value of an attribute.
"""
attributeValue: AttributeValue
}
type ProductVariantTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Returns translated product variant fields for the given language code.
"""
translation(
"""
A language code to return the translation for product variant.
"""
languageCode: LanguageCodeEnum!
): ProductVariantTranslation
"""
Represents a version of a product such as different size or color.
"""
productVariant: ProductVariant
}
type PageTranslatableContent implements Node {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
title: String!
content: JSONString
"""
Content of the page (JSON).
"""
contentJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `content` field instead."
)
"""
Returns translated page fields for the given language code.
"""
translation(
"""
A language code to return the translation for page.
"""
languageCode: LanguageCodeEnum!
): PageTranslation
"""
('A static page that can be manually added by a shop operator ', 'through the dashboard.')
"""
page: Page
}
type PageTranslation implements Node {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
title: String!
content: JSONString
"""
Translation language.
"""
language: LanguageDisplay!
"""
Translated description of the page (JSON).
"""
contentJson: JSONString
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `content` field instead."
)
}
"""
A static page that can be manually added by a shop operator through the dashboard.
"""
type Page implements Node & ObjectWithMetadata {
seoTitle: String
seoDescription: String
"""
The ID of the object.
"""
id: ID!
title: String!
content: JSONString
publicationDate: Date
isPublished: Boolean!
slug: String!
pageType: PageType!
created: DateTime!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Content of the page (JSON).
"""
contentJson: JSONString!
@deprecated(
reason: "Will be removed in Saleor 4.0. Use the `content` field instead."
)
"""
Returns translated page fields for the given language code.
"""
translation(
"""
A language code to return the translation for page.
"""
languageCode: LanguageCodeEnum!
): PageTranslation
"""
List of attributes assigned to this product.
"""
attributes: [SelectedAttribute!]!
}
"""
Represents a type of page. It defines what attributes are available to pages of this type.
"""
type PageType implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
slug: String!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Page attributes of that page type.
"""
attributes: [Attribute]
"""
Attributes that can be assigned to the page type.
"""
availableAttributes(
filter: AttributeFilterInput
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): AttributeCountableConnection
"""
Whether page type has pages assigned.
"""
hasPages: Boolean
}
type ShippingMethodTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
description: JSONString
"""
Returns translated shipping method fields for the given language code.
"""
translation(
"""
A language code to return the translation for shipping method.
"""
languageCode: LanguageCodeEnum!
): ShippingMethodTranslation
"""
Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.
"""
shippingMethod: ShippingMethod
}
type SaleTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Returns translated sale fields for the given language code.
"""
translation(
"""
A language code to return the translation for sale.
"""
languageCode: LanguageCodeEnum!
): SaleTranslation
"""
Sales allow creating discounts for categories, collections or products and are visible to all the customers.
"""
sale: Sale
}
type SaleTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
name: String
"""
Translation language.
"""
language: LanguageDisplay!
}
"""
Sales allow creating discounts for categories, collections or products and are visible to all the customers.
"""
type Sale implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
type: SaleType!
startDate: DateTime!
endDate: DateTime
"""
List of categories this sale applies to.
"""
categories(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CategoryCountableConnection
"""
List of collections this sale applies to.
"""
collections(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CollectionCountableConnection
"""
List of products this sale applies to.
"""
products(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductCountableConnection
"""
Returns translated sale fields for the given language code.
"""
translation(
"""
A language code to return the translation for sale.
"""
languageCode: LanguageCodeEnum!
): SaleTranslation
"""
List of channels available for the sale.
"""
channelListings: [SaleChannelListing!]
"""
Sale value.
"""
discountValue: Float
"""
Currency code for sale.
"""
currency: String
}
"""
An enumeration.
"""
enum SaleType {
"""
fixed
"""
FIXED
"""
%
"""
PERCENTAGE
}
type CollectionCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [CollectionCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type CollectionCountableEdge {
"""
The item at the end of the edge.
"""
node: Collection!
"""
A cursor for use in pagination.
"""
cursor: String!
}
"""
Represents sale channel listing.
"""
type SaleChannelListing implements Node {
"""
The ID of the object.
"""
id: ID!
channel: Channel!
discountValue: Float!
currency: String!
}
type VoucherTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
name: String
"""
Returns translated voucher fields for the given language code.
"""
translation(
"""
A language code to return the translation for voucher.
"""
languageCode: LanguageCodeEnum!
): VoucherTranslation
"""
Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.
"""
voucher: Voucher
}
type VoucherTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
name: String
"""
Translation language.
"""
language: LanguageDisplay!
}
"""
Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.
"""
type Voucher implements Node {
"""
The ID of the object.
"""
id: ID!
name: String
"""
Determines a type of voucher.
"""
type: VoucherTypeEnum!
code: String!
usageLimit: Int
used: Int!
startDate: DateTime!
endDate: DateTime
applyOncePerOrder: Boolean!
applyOncePerCustomer: Boolean!
"""
Determines a type of discount for voucher - value or percentage
"""
discountValueType: DiscountValueTypeEnum!
minCheckoutItemsQuantity: Int
"""
List of categories this voucher applies to.
"""
categories(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CategoryCountableConnection
"""
List of collections this voucher applies to.
"""
collections(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): CollectionCountableConnection
"""
List of products this voucher applies to.
"""
products(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): ProductCountableConnection
"""
List of countries available for the shipping voucher.
"""
countries: [CountryDisplay]
"""
Returns translated voucher fields for the given language code.
"""
translation(
"""
A language code to return the translation for voucher.
"""
languageCode: LanguageCodeEnum!
): VoucherTranslation
"""
Voucher value.
"""
discountValue: Float
"""
Currency code for voucher.
"""
currency: String
"""
Minimum order value to apply voucher.
"""
minSpent: Money
"""
List of availability in channels for the voucher.
"""
channelListings: [VoucherChannelListing!]
}
enum VoucherTypeEnum {
SHIPPING
ENTIRE_ORDER
SPECIFIC_PRODUCT
}
enum DiscountValueTypeEnum {
FIXED
PERCENTAGE
}
"""
Represents voucher channel listing.
"""
type VoucherChannelListing implements Node {
"""
The ID of the object.
"""
id: ID!
channel: Channel!
discountValue: Float!
currency: String!
minSpent: Money
}
type MenuItemTranslatableContent implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Returns translated menu item fields for the given language code.
"""
translation(
"""
A language code to return the translation for menu item.
"""
languageCode: LanguageCodeEnum!
): MenuItemTranslation
"""
Represents a single item of the related menu. Can store categories, collection or pages.
"""
menuItem: MenuItem
}
type MenuItemTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
Translation language.
"""
language: LanguageDisplay!
}
"""
Represents a single item of the related menu. Can store categories, collection or pages.
"""
type MenuItem implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
menu: Menu!
parent: MenuItem
category: Category
collection: Collection
page: Page
level: Int!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
children: [MenuItem]
"""
URL to the menu item.
"""
url: String
"""
Returns translated menu item fields for the given language code.
"""
translation(
"""
A language code to return the translation for menu item.
"""
languageCode: LanguageCodeEnum!
): MenuItemTranslation
}
"""
Represents a single menu - an object that is used to help navigate through the store.
"""
type Menu implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
name: String!
slug: String!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
items: [MenuItem]
}
enum TranslatableKinds {
ATTRIBUTE
ATTRIBUTE_VALUE
CATEGORY
COLLECTION
MENU_ITEM
PAGE
PRODUCT
SALE
SHIPPING_METHOD
VARIANT
VOUCHER
}
type StockCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [StockCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type StockCountableEdge {
"""
The item at the end of the edge.
"""
node: Stock!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input StockFilterInput {
quantity: Float
search: String
}
"""
Represents a shop resource containing general shop data and configuration.
"""
type Shop {
"""
List of available payment gateways.
"""
availablePaymentGateways(
"""
A currency for which gateways will be returned.
"""
currency: String
): [PaymentGateway!]!
"""
List of available external authentications.
"""
availableExternalAuthentications: [ExternalAuthentication!]!
"""
Shipping methods that are available for the shop.
"""
availableShippingMethods(
"""
Slug of a channel for which the data should be returned.
"""
channel: String!
"""
Address for which available shipping methods should be returned.
"""
address: AddressInput
): [ShippingMethod]
"""
List of countries available in the shop.
"""
countries(
"""
A language code to return the translation for.
"""
languageCode: LanguageCodeEnum
): [CountryDisplay!]!
"""
Shop's default country.
"""
defaultCountry: CountryDisplay
"""
Default shop's email sender's name.
"""
defaultMailSenderName: String
"""
Default shop's email sender's address.
"""
defaultMailSenderAddress: String
"""
Shop's description.
"""
description: String
"""
Shop's domain data.
"""
domain: Domain!
"""
List of the shops's supported languages.
"""
languages: [LanguageDisplay]!
"""
Shop's name.
"""
name: String!
"""
Shop's navigation.
"""
navigation: Navigation
@deprecated(
reason: "Fetch menus using the `menu` query with `slug` parameter."
)
"""
List of available permissions.
"""
permissions: [Permission]!
"""
List of possible phone prefixes.
"""
phonePrefixes: [String]!
"""
Header text.
"""
headerText: String
"""
Include taxes in prices.
"""
includeTaxesInPrices: Boolean!
"""
Display prices with tax in store.
"""
displayGrossPrices: Boolean!
"""
Charge taxes on shipping.
"""
chargeTaxesOnShipping: Boolean!
"""
Enable inventory tracking.
"""
trackInventoryByDefault: Boolean
"""
Default weight unit.
"""
defaultWeightUnit: WeightUnitsEnum
"""
Returns translated shop fields for the given language code.
"""
translation(
"""
A language code to return the translation for shop.
"""
languageCode: LanguageCodeEnum!
): ShopTranslation
"""
Enable automatic fulfillment for all digital products.
"""
automaticFulfillmentDigitalProducts: Boolean
"""
Default number of max downloads per digital content URL.
"""
defaultDigitalMaxDownloads: Int
"""
Default number of days which digital content URL will be valid.
"""
defaultDigitalUrlValidDays: Int
"""
Company address.
"""
companyAddress: Address
"""
URL of a view where customers can set their password.
"""
customerSetPasswordUrl: String
"""
List of staff notification recipients.
"""
staffNotificationRecipients: [StaffNotificationRecipient]
"""
Resource limitations and current usage if any set for a shop
"""
limits: LimitInfo!
"""
Saleor API version.
"""
version: String!
}
"""
Available payment gateway backend with configuration necessary to setup client.
"""
type PaymentGateway {
"""
Payment gateway name.
"""
name: String!
"""
Payment gateway ID.
"""
id: ID!
"""
Payment gateway client configuration.
"""
config: [GatewayConfigLine!]!
"""
Payment gateway supported currencies.
"""
currencies: [String]!
}
"""
Payment gateway client configuration key and value pair.
"""
type GatewayConfigLine {
"""
Gateway config key.
"""
field: String!
"""
Gateway config value for key.
"""
value: String
}
type ExternalAuthentication {
"""
ID of external authentication plugin.
"""
id: String!
"""
Name of external authentication plugin.
"""
name: String
}
"""
Represents shop's domain.
"""
type Domain {
"""
The host name of the domain.
"""
host: String!
"""
Inform if SSL is enabled.
"""
sslEnabled: Boolean!
"""
Shop's absolute URL.
"""
url: String!
}
"""
Represents shop's navigation menus.
"""
type Navigation {
"""
Main navigation bar.
"""
main: Menu
"""
Secondary navigation bar.
"""
secondary: Menu
}
type ShopTranslation implements Node {
"""
The ID of the object.
"""
id: ID!
headerText: String!
description: String!
"""
Translation language.
"""
language: LanguageDisplay!
}
"""
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.
"""
type StaffNotificationRecipient implements Node {
"""
Returns a user subscribed to email notifications.
"""
user: User
"""
Determines if a notification active.
"""
active: Boolean
"""
The ID of the object.
"""
id: ID!
"""
Returns email address of a user subscribed to email notifications.
"""
email: String
}
"""
Represents user data.
"""
type User implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
lastLogin: DateTime
email: String!
firstName: String!
lastName: String!
isStaff: Boolean!
isActive: Boolean!
"""
A note about the customer.
"""
note: String
dateJoined: DateTime!
defaultShippingAddress: Address
defaultBillingAddress: Address
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
List of all user's addresses.
"""
addresses: [Address]
"""
Returns the last open checkout of this user.
"""
checkout: Checkout
@deprecated(
reason: "Use the `checkout_tokens` field to fetch the user checkouts."
)
"""
Returns the checkout UUID's assigned to this user.
"""
checkoutTokens(
"""
Slug of a channel for which the data should be returned.
"""
channel: String
): [UUID!]
"""
List of the user gift cards.
"""
giftCards(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): GiftCardCountableConnection
"""
List of user's orders.
"""
orders(
"""
Return the elements in the list that come before the specified cursor.
"""
before: String
"""
Return the elements in the list that come after the specified cursor.
"""
after: String
"""
Return the first n elements from the list.
"""
first: Int
"""
Return the last n elements from the list.
"""
last: Int
): OrderCountableConnection
"""
List of user's permissions.
"""
permissions: [Permission]
@deprecated(
reason: "Will be removed in Saleor 2.11.Use the `userPermissions` instead."
)
"""
List of user's permissions.
"""
userPermissions: [UserPermission]
"""
List of user's permission groups.
"""
permissionGroups: [Group]
"""
List of user's permission groups which user can manage.
"""
editableGroups: [Group]
avatar(
"""
Size of the avatar.
"""
size: Int
): Image
"""
List of events associated with the user.
"""
events: [CustomerEvent]
"""
List of stored payment sources.
"""
storedPaymentSources: [PaymentSource]
"""
User language code.
"""
languageCode: LanguageCodeEnum!
}
"""
Checkout object.
"""
type Checkout implements Node & ObjectWithMetadata {
created: DateTime!
lastChange: DateTime!
user: User
quantity: Int!
channel: Channel!
billingAddress: Address
shippingAddress: Address
note: String!
discount: Money
discountName: String
translatedDiscountName: String
voucherCode: String
"""
List of gift cards associated with this checkout.
"""
giftCards: [GiftCard]
"""
The ID of the object.
"""
id: ID!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Shipping methods that can be used with this order.
"""
availableShippingMethods: [ShippingMethod]!
"""
List of available payment gateways.
"""
availablePaymentGateways: [PaymentGateway!]!
"""
Email of a customer.
"""
email: String!
"""
Returns True, if checkout requires shipping.
"""
isShippingRequired: Boolean!
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLine]
"""
The price of the shipping, with all the taxes included.
"""
shippingPrice: TaxedMoney
"""
The shipping method related with checkout.
"""
shippingMethod: ShippingMethod
"""
The price of the checkout before shipping, with taxes included.
"""
subtotalPrice: TaxedMoney
"""
The checkout's token.
"""
token: UUID!
"""
The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included.
"""
totalPrice: TaxedMoney
"""
Checkout language code.
"""
languageCode: LanguageCodeEnum!
}
"""
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.
"""
type GiftCard implements Node {
"""
Gift card code.
"""
code: String
"""
The customer who bought a gift card.
"""
user: User
created: DateTime!
startDate: Date!
endDate: Date
lastUsedOn: DateTime
isActive: Boolean!
initialBalance: Money
currentBalance: Money
"""
The ID of the object.
"""
id: ID!
"""
Code in format which allows displaying in a user interface.
"""
displayCode: String
}
"""
Represents an item in the checkout.
"""
type CheckoutLine implements Node {
"""
The ID of the object.
"""
id: ID!
variant: ProductVariant!
quantity: Int!
"""
The sum of the checkout line price, taxes and discounts.
"""
totalPrice: TaxedMoney
"""
Indicates whether the item need to be delivered.
"""
requiresShipping: Boolean
}
type GiftCardCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [GiftCardCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type GiftCardCountableEdge {
"""
The item at the end of the edge.
"""
node: GiftCard!
"""
A cursor for use in pagination.
"""
cursor: String!
}
type OrderCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [OrderCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type OrderCountableEdge {
"""
The item at the end of the edge.
"""
node: Order!
"""
A cursor for use in pagination.
"""
cursor: String!
}
"""
Represents an order in the shop.
"""
type Order implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
created: DateTime!
status: OrderStatus!
user: User
trackingClientId: String!
billingAddress: Address
shippingAddress: Address
shippingMethod: ShippingMethod
shippingMethodName: String
channel: Channel!
"""
Total price of shipping.
"""
shippingPrice: TaxedMoney!
shippingTaxRate: Float!
token: String!
voucher: Voucher
"""
List of user gift cards.
"""
giftCards: [GiftCard]
displayGrossPrices: Boolean!
customerNote: String!
weight: Weight
redirectUrl: String
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
List of shipments for the order.
"""
fulfillments: [Fulfillment]!
"""
List of order lines.
"""
lines: [OrderLine]!
"""
List of actions that can be performed in the current state of an order.
"""
actions: [OrderAction]!
"""
Shipping methods that can be used with this order.
"""
availableShippingMethods: [ShippingMethod]
"""
List of order invoices.
"""
invoices: [Invoice]
"""
User-friendly number of an order.
"""
number: String
"""
Informs if an order is fully paid.
"""
isPaid: Boolean!
"""
Internal payment status.
"""
paymentStatus: PaymentChargeStatusEnum!
"""
User-friendly payment status.
"""
paymentStatusDisplay: String!
"""
List of payments for the order.
"""
payments: [Payment]
"""
Total amount of the order.
"""
total: TaxedMoney!
"""
Undiscounted total amount of the order.
"""
undiscountedTotal: TaxedMoney!
"""
The sum of line prices not including shipping.
"""
subtotal: TaxedMoney!
"""
User-friendly order status.
"""
statusDisplay: String
"""
Informs whether a draft order can be finalized(turned into a regular order).
"""
canFinalize: Boolean!
"""
Amount authorized for the order.
"""
totalAuthorized: Money!
"""
Amount captured by payment.
"""
totalCaptured: Money!
"""
List of events associated with the order.
"""
events: [OrderEvent]
"""
The difference between the paid and the order total amount.
"""
totalBalance: Money!
"""
Email address of the customer.
"""
userEmail: String
"""
Returns True, if order requires shipping.
"""
isShippingRequired: Boolean!
languageCode: String!
@deprecated(
reason: "Use the `languageCodeEnum` field to fetch the language code. This field will be removed in Saleor 4.0."
)
"""
Order language code.
"""
languageCodeEnum: LanguageCodeEnum!
"""
Returns applied discount.
"""
discount: Money
@deprecated(
reason: "Use discounts field. This field will be removed in Saleor 4.0."
)
"""
Discount name.
"""
discountName: String
@deprecated(
reason: "Use discounts field. This field will be removed in Saleor 4.0."
)
"""
Translated discount name.
"""
translatedDiscountName: String
@deprecated(
reason: "Use discounts field. This field will be removed in Saleor 4.0."
)
"""
List of all discounts assigned to the order.
"""
discounts: [OrderDiscount!]
}
"""
An enumeration.
"""
enum OrderStatus {
"""
Draft
"""
DRAFT
"""
Unconfirmed
"""
UNCONFIRMED
"""
Unfulfilled
"""
UNFULFILLED
"""
Partially fulfilled
"""
PARTIALLY_FULFILLED
"""
Partially returned
"""
PARTIALLY_RETURNED
"""
Returned
"""
RETURNED
"""
Fulfilled
"""
FULFILLED
"""
Canceled
"""
CANCELED
}
"""
Represents order fulfillment.
"""
type Fulfillment implements Node & ObjectWithMetadata {
"""
The ID of the object.
"""
id: ID!
fulfillmentOrder: Int!
status: FulfillmentStatus!
trackingNumber: String!
created: DateTime!
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
List of lines for the fulfillment.
"""
lines: [FulfillmentLine]
"""
User-friendly fulfillment status.
"""
statusDisplay: String
"""
Warehouse from fulfillment was fulfilled.
"""
warehouse: Warehouse
}
"""
An enumeration.
"""
enum FulfillmentStatus {
"""
Fulfilled
"""
FULFILLED
"""
Refunded
"""
REFUNDED
"""
Returned
"""
RETURNED
"""
Replaced
"""
REPLACED
"""
Refunded and returned
"""
REFUNDED_AND_RETURNED
"""
Canceled
"""
CANCELED
}
"""
Represents line of the fulfillment.
"""
type FulfillmentLine implements Node {
"""
The ID of the object.
"""
id: ID!
quantity: Int!
orderLine: OrderLine
}
"""
Represents order line of particular order.
"""
type OrderLine implements Node {
"""
The ID of the object.
"""
id: ID!
productName: String!
variantName: String!
productSku: String!
isShippingRequired: Boolean!
quantity: Int!
quantityFulfilled: Int!
unitDiscountReason: String
taxRate: Float!
digitalContentUrl: DigitalContentUrl
"""
The main thumbnail for the ordered product.
"""
thumbnail(
"""
Size of thumbnail.
"""
size: Int
): Image
"""
Price of the single item in the order line.
"""
unitPrice: TaxedMoney!
"""
Price of the single item in the order line without applied an order line discount.
"""
undiscountedUnitPrice: TaxedMoney!
"""
The discount applied to the single order line.
"""
unitDiscount: Money!
"""
Value of the discount. Can store fixed value or percent value
"""
unitDiscountValue: PositiveDecimal!
"""
Price of the order line.
"""
totalPrice: TaxedMoney!
"""
A purchased product variant. Note: this field may be null if the variant has been removed from stock at all.
"""
variant: ProductVariant
"""
Product name in the customer's language
"""
translatedProductName: String!
"""
Variant name in the customer's language
"""
translatedVariantName: String!
"""
List of allocations across warehouses.
"""
allocations: [Allocation!]
"""
Type of the discount: fixed or percent
"""
unitDiscountType: DiscountValueTypeEnum
}
"""
Positive Decimal scalar implementation.
Should be used in places where value must be positive.
"""
scalar PositiveDecimal
"""
Represents allocation.
"""
type Allocation implements Node {
"""
The ID of the object.
"""
id: ID!
"""
Quantity allocated for orders.
"""
quantity: Int!
"""
The warehouse were items were allocated.
"""
warehouse: Warehouse!
}
enum OrderAction {
"""
Represents the capture action.
"""
CAPTURE
"""
Represents a mark-as-paid action.
"""
MARK_AS_PAID
"""
Represents a refund action.
"""
REFUND
"""
Represents a void action.
"""
VOID
}
"""
Represents an Invoice.
"""
type Invoice implements ObjectWithMetadata & Job & Node {
"""
The ID of the object.
"""
id: ID!
"""
List of public metadata items. Can be accessed without permissions.
"""
metadata: [MetadataItem]!
"""
Job status.
"""
status: JobStatusEnum!
number: String
externalUrl: String
"""
List of private metadata items.Requires proper staff permissions to access.
"""
privateMetadata: [MetadataItem]!
"""
Created date time of job in ISO 8601 format.
"""
createdAt: DateTime!
"""
Date time of job last update in ISO 8601 format.
"""
updatedAt: DateTime!
"""
Job message.
"""
message: String
"""
URL to download an invoice.
"""
url: String
}
interface Job {
"""
Job status.
"""
status: JobStatusEnum!
"""
Created date time of job in ISO 8601 format.
"""
createdAt: DateTime!
"""
Date time of job last update in ISO 8601 format.
"""
updatedAt: DateTime!
"""
Job message.
"""
message: String
}
"""
An enumeration.
"""
enum JobStatusEnum {
PENDING
SUCCESS
FAILED
DELETED
}
"""
An enumeration.
"""
enum PaymentChargeStatusEnum {
NOT_CHARGED
PENDING
PARTIALLY_CHARGED
FULLY_CHARGED
PARTIALLY_REFUNDED
FULLY_REFUNDED
REFUSED
CANCELLED
}
"""
Represents a payment of a given type.
"""
type Payment implements Node {
"""
The ID of the object.
"""
id: ID!
gateway: String!
isActive: Boolean!
created: DateTime!
modified: DateTime!
token: String!
checkout: Checkout
order: Order
paymentMethodType: String!
customerIpAddress: String
"""
Internal payment status.
"""
chargeStatus: PaymentChargeStatusEnum!
"""
List of actions that can be performed in the current state of a payment.
"""
actions: [OrderAction]!
"""
Total amount of the payment.
"""
total: Money
"""
Total amount captured for this payment.
"""
capturedAmount: Money
"""
List of all transactions within this payment.
"""
transactions: [Transaction]
"""
Maximum amount of money that can be captured.
"""
availableCaptureAmount: Money
"""
Maximum amount of money that can be refunded.
"""
availableRefundAmount: Money
"""
The details of the card used for this payment.
"""
creditCard: CreditCard
}
"""
An object representing a single payment.
"""
type Transaction implements Node {
"""
The ID of the object.
"""
id: ID!
created: DateTime!
payment: Payment!
token: String!
kind: TransactionKind!
isSuccess: Boolean!
error: String
gatewayResponse: JSONString!
"""
Total amount of the transaction.
"""
amount: Money
}
"""
An enumeration.
"""
enum TransactionKind {
"""
External reference
"""
EXTERNAL
"""
Authorization
"""
AUTH
"""
Pending
"""
PENDING
"""
Action to confirm
"""
ACTION_TO_CONFIRM
"""
Refund
"""
REFUND
"""
Refund in progress
"""
REFUND_ONGOING
"""
Capture
"""
CAPTURE
"""
Void
"""
VOID
"""
Confirm
"""
CONFIRM
"""
Cancel
"""
CANCEL
}
type CreditCard {
"""
Card brand.
"""
brand: String!
"""
First 4 digits of the card number.
"""
firstDigits: String
"""
Last 4 digits of the card number.
"""
lastDigits: String!
"""
Two-digit number representing the card’s expiration month.
"""
expMonth: Int
"""
Four-digit number representing the card’s expiration year.
"""
expYear: Int
}
"""
History log of the order.
"""
type OrderEvent implements Node {
"""
The ID of the object.
"""
id: ID!
"""
Date when event happened at in ISO 8601 format.
"""
date: DateTime
"""
Order event type.
"""
type: OrderEventsEnum
"""
User who performed the action.
"""
user: User
"""
Content of the event.
"""
message: String
"""
Email of the customer.
"""
email: String
"""
Type of an email sent to the customer.
"""
emailType: OrderEventsEmailsEnum
"""
Amount of money.
"""
amount: Float
"""
The payment ID from the payment gateway.
"""
paymentId: String
"""
The payment gateway of the payment.
"""
paymentGateway: String
"""
Number of items.
"""
quantity: Int
"""
Composed ID of the Fulfillment.
"""
composedId: String
"""
User-friendly number of an order.
"""
orderNumber: String
"""
Number of an invoice related to the order.
"""
invoiceNumber: String
"""
List of oversold lines names.
"""
oversoldItems: [String]
"""
The concerned lines.
"""
lines: [OrderEventOrderLineObject]
"""
The lines fulfilled.
"""
fulfilledItems: [FulfillmentLine]
"""
The warehouse were items were restocked.
"""
warehouse: Warehouse
"""
The transaction reference of captured payment.
"""
transactionReference: String
"""
Define if shipping costs were included to the refund.
"""
shippingCostsIncluded: Boolean
"""
The order which is related to this order.
"""
relatedOrder: Order
"""
The discount applied to the order.
"""
discount: OrderEventDiscountObject
}
"""
An enumeration.
"""
enum OrderEventsEnum {
DRAFT_CREATED
DRAFT_CREATED_FROM_REPLACE
ADDED_PRODUCTS
REMOVED_PRODUCTS
PLACED
PLACED_FROM_DRAFT
OVERSOLD_ITEMS
CANCELED
ORDER_MARKED_AS_PAID
ORDER_FULLY_PAID
ORDER_REPLACEMENT_CREATED
ORDER_DISCOUNT_ADDED
ORDER_DISCOUNT_AUTOMATICALLY_UPDATED
ORDER_DISCOUNT_UPDATED
ORDER_DISCOUNT_DELETED
ORDER_LINE_DISCOUNT_UPDATED
ORDER_LINE_DISCOUNT_REMOVED
UPDATED_ADDRESS
EMAIL_SENT
CONFIRMED
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
FULFILLMENT_REFUNDED
FULFILLMENT_RETURNED
FULFILLMENT_REPLACED
TRACKING_UPDATED
NOTE_ADDED
OTHER
}
"""
An enumeration.
"""
enum OrderEventsEmailsEnum {
PAYMENT_CONFIRMATION
CONFIRMED
SHIPPING_CONFIRMATION
TRACKING_UPDATED
ORDER_CONFIRMATION
ORDER_CANCEL
ORDER_REFUND
FULFILLMENT_CONFIRMATION
DIGITAL_LINKS
}
type OrderEventOrderLineObject {
"""
The variant quantity.
"""
quantity: Int
"""
The order line.
"""
orderLine: OrderLine
"""
The variant name.
"""
itemName: String
"""
The discount applied to the order line.
"""
discount: OrderEventDiscountObject
}
type OrderEventDiscountObject {
"""
Type of the discount: fixed or percent.
"""
valueType: DiscountValueTypeEnum!
"""
Value of the discount. Can store fixed value or percent value.
"""
value: PositiveDecimal!
"""
Explanation for the applied discount.
"""
reason: String
"""
Returns amount of discount.
"""
amount: Money
"""
Type of the discount: fixed or percent.
"""
oldValueType: DiscountValueTypeEnum
"""
Value of the discount. Can store fixed value or percent value.
"""
oldValue: PositiveDecimal
"""
Returns amount of discount.
"""
oldAmount: Money
}
"""
Contains all details related to the applied discount to the order.
"""
type OrderDiscount implements Node {
"""
The ID of the object.
"""
id: ID!
type: OrderDiscountType!
"""
Type of the discount: fixed or percent
"""
valueType: DiscountValueTypeEnum!
"""
Value of the discount. Can store fixed value or percent value
"""
value: PositiveDecimal!
name: String
translatedName: String
"""
Explanation for the applied discount.
"""
reason: String
"""
Returns amount of discount.
"""
amount: Money!
}
"""
An enumeration.
"""
enum OrderDiscountType {
"""
Voucher
"""
VOUCHER
"""
Manual
"""
MANUAL
}
type UserPermission {
"""
Internal code for permission.
"""
code: PermissionEnum!
"""
Describe action(s) allowed to do by permission.
"""
name: String!
"""
List of user permission groups which contains this permission.
"""
sourcePermissionGroups(
"""
ID of user whose groups should be returned.
"""
userId: ID!
): [Group!]
}
"""
Represents permission group data.
"""
type Group implements Node {
"""
The ID of the object.
"""
id: ID!
name: String!
"""
List of group permissions
"""
permissions: [Permission]
"""
List of group users
"""
users: [User]
"""
True, if the currently authenticated user has rights to manage a group.
"""
userCanManage: Boolean!
}
"""
History log of the customer.
"""
type CustomerEvent implements Node {
"""
The ID of the object.
"""
id: ID!
"""
Date when event happened at in ISO 8601 format.
"""
date: DateTime
"""
Customer event type.
"""
type: CustomerEventsEnum
"""
User who performed the action.
"""
user: User
"""
Content of the event.
"""
message: String
"""
Number of objects concerned by the event.
"""
count: Int
"""
The concerned order.
"""
order: Order
"""
The concerned order line.
"""
orderLine: OrderLine
}
"""
An enumeration.
"""
enum CustomerEventsEnum {
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
}
"""
Represents a payment source stored for user in payment gateway, such as credit card.
"""
type PaymentSource {
"""
Payment gateway name.
"""
gateway: String!
"""
Stored credit card details if available.
"""
creditCardInfo: CreditCard
}
type LimitInfo {
"""
Defines the current resource usage.
"""
currentUsage: Limits!
"""
Defines the allowed maximum resource usage, null means unlimited.
"""
allowedUsage: Limits!
}
type Limits {
channels: Int
orders: Int
productVariants: Int
staffUsers: Int
warehouses: Int
}
"""
Order related settings from site settings.
"""
type OrderSettings {
automaticallyConfirmAllNewOrders: Boolean!
}
input ShippingZoneFilterInput {
search: String
}
type DigitalContentCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [DigitalContentCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type DigitalContentCountableEdge {
"""
The item at the end of the edge.
"""
node: DigitalContent!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input CategoryFilterInput {
search: String
metadata: [MetadataInput]
ids: [ID]
}
input CategorySortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
"""
channel: String
"""
Sort categories by the selected field.
"""
field: CategorySortField!
}
enum CategorySortField {
"""
Sort categories by name.
"""
NAME
"""
Sort categories by product count.
"""
PRODUCT_COUNT
"""
Sort categories by subcategory count.
"""
SUBCATEGORY_COUNT
}
input CollectionFilterInput {
published: CollectionPublished
search: String
metadata: [MetadataInput]
ids: [ID]
"""
Specifies the channel by which the data should be sorted.
"""
channel: String
}
enum CollectionPublished {
PUBLISHED
HIDDEN
}
input CollectionSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
"""
channel: String
"""
Sort collections by the selected field.
"""
field: CollectionSortField!
}
enum CollectionSortField {
"""
Sort collections by name.
"""
NAME
"""
Sort collections by availability.
"""
AVAILABILITY
"""
Sort collections by product count.
"""
PRODUCT_COUNT
"""
Sort collections by publication date.
"""
PUBLICATION_DATE
}
input ProductTypeFilterInput {
search: String
configurable: ProductTypeConfigurable
productType: ProductTypeEnum
metadata: [MetadataInput]
ids: [ID]
}
enum ProductTypeConfigurable {
CONFIGURABLE
SIMPLE
}
enum ProductTypeEnum {
DIGITAL
SHIPPABLE
}
input ProductTypeSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort product types by the selected field.
"""
field: ProductTypeSortField!
}
enum ProductTypeSortField {
"""
Sort products by name.
"""
NAME
"""
Sort products by type.
"""
DIGITAL
"""
Sort products by shipping.
"""
SHIPPING_REQUIRED
}
type ProductVariantCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [ProductVariantCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type ProductVariantCountableEdge {
"""
The item at the end of the edge.
"""
node: ProductVariant!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input ProductVariantFilterInput {
search: String
sku: [String]
metadata: [MetadataInput]
}
type PaymentCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [PaymentCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type PaymentCountableEdge {
"""
The item at the end of the edge.
"""
node: Payment!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input PaymentFilterInput {
checkouts: [ID]
}
type PageCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [PageCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type PageCountableEdge {
"""
The item at the end of the edge.
"""
node: Page!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input PageSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort pages by the selected field.
"""
field: PageSortField!
}
enum PageSortField {
"""
Sort pages by title.
"""
TITLE
"""
Sort pages by slug.
"""
SLUG
"""
Sort pages by visibility.
"""
VISIBILITY
"""
Sort pages by creation date.
"""
CREATION_DATE
"""
Sort pages by publication date.
"""
PUBLICATION_DATE
}
input PageFilterInput {
search: String
metadata: [MetadataInput]
}
type PageTypeCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [PageTypeCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type PageTypeCountableEdge {
"""
The item at the end of the edge.
"""
node: PageType!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input PageTypeSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort page types by the selected field.
"""
field: PageTypeSortField!
}
enum PageTypeSortField {
"""
Sort page types by name.
"""
NAME
"""
Sort page types by slug.
"""
SLUG
}
input PageTypeFilterInput {
search: String
}
type OrderEventCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [OrderEventCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type OrderEventCountableEdge {
"""
The item at the end of the edge.
"""
node: OrderEvent!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input OrderSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort orders by the selected field.
"""
field: OrderSortField!
}
enum OrderSortField {
"""
Sort orders by number.
"""
NUMBER
"""
Sort orders by creation date.
"""
CREATION_DATE
"""
Sort orders by customer.
"""
CUSTOMER
"""
Sort orders by payment.
"""
PAYMENT
"""
Sort orders by fulfillment status.
"""
FULFILLMENT_STATUS
}
input OrderFilterInput {
paymentStatus: [PaymentChargeStatusEnum]
status: [OrderStatusFilter]
customer: String
created: DateRangeInput
search: String
metadata: [MetadataInput]
channels: [ID]
}
enum OrderStatusFilter {
READY_TO_FULFILL
READY_TO_CAPTURE
UNFULFILLED
UNCONFIRMED
PARTIALLY_FULFILLED
FULFILLED
CANCELED
}
input DateRangeInput {
"""
Start date.
"""
gte: Date
"""
End date.
"""
lte: Date
}
input OrderDraftFilterInput {
customer: String
created: DateRangeInput
search: String
metadata: [MetadataInput]
channels: [ID]
}
type MenuCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [MenuCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type MenuCountableEdge {
"""
The item at the end of the edge.
"""
node: Menu!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input MenuSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort menus by the selected field.
"""
field: MenuSortField!
}
enum MenuSortField {
"""
Sort menus by name.
"""
NAME
"""
Sort menus by items count.
"""
ITEMS_COUNT
}
input MenuFilterInput {
search: String
slug: [String]
metadata: [MetadataInput]
}
type MenuItemCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [MenuItemCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type MenuItemCountableEdge {
"""
The item at the end of the edge.
"""
node: MenuItem!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input MenuItemSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort menu items by the selected field.
"""
field: MenuItemsSortField!
}
enum MenuItemsSortField {
"""
Sort menu items by name.
"""
NAME
}
input MenuItemFilterInput {
search: String
metadata: [MetadataInput]
}
"""
Plugin.
"""
type Plugin implements Node {
id: ID!
name: String!
description: String!
active: Boolean!
configuration: [ConfigurationItem]
}
"""
Stores information about a single configuration field.
"""
type ConfigurationItem {
"""
Name of the field.
"""
name: String!
"""
Current value of the field.
"""
value: String
"""
Type of the field.
"""
type: ConfigurationTypeFieldEnum
"""
Help text for the field.
"""
helpText: String
"""
Label for the field.
"""
label: String
}
"""
An enumeration.
"""
enum ConfigurationTypeFieldEnum {
STRING
MULTILINE
BOOLEAN
SECRET
PASSWORD
SECRETMULTILINE
}
type PluginCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [PluginCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type PluginCountableEdge {
"""
The item at the end of the edge.
"""
node: Plugin!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input PluginFilterInput {
active: Boolean
search: String
}
input PluginSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort plugins by the selected field.
"""
field: PluginSortField!
}
enum PluginSortField {
NAME
IS_ACTIVE
}
type SaleCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [SaleCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type SaleCountableEdge {
"""
The item at the end of the edge.
"""
node: Sale!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input SaleFilterInput {
status: [DiscountStatusEnum]
saleType: DiscountValueTypeEnum
started: DateTimeRangeInput
search: String
}
enum DiscountStatusEnum {
ACTIVE
EXPIRED
SCHEDULED
}
input DateTimeRangeInput {
"""
Start date.
"""
gte: DateTime
"""
End date.
"""
lte: DateTime
}
input SaleSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
"""
channel: String
"""
Sort sales by the selected field.
"""
field: SaleSortField!
}
enum SaleSortField {
"""
Sort sales by name.
"""
NAME
"""
Sort sales by start date.
"""
START_DATE
"""
Sort sales by end date.
"""
END_DATE
"""
Sort sales by value.
"""
VALUE
"""
Sort sales by type.
"""
TYPE
}
type VoucherCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [VoucherCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type VoucherCountableEdge {
"""
The item at the end of the edge.
"""
node: Voucher!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input VoucherFilterInput {
status: [DiscountStatusEnum]
timesUsed: IntRangeInput
discountType: [VoucherDiscountType]
started: DateTimeRangeInput
search: String
}
enum VoucherDiscountType {
FIXED
PERCENTAGE
SHIPPING
}
input VoucherSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
"""
channel: String
"""
Sort vouchers by the selected field.
"""
field: VoucherSortField!
}
enum VoucherSortField {
"""
Sort vouchers by code.
"""
CODE
"""
Sort vouchers by start date.
"""
START_DATE
"""
Sort vouchers by end date.
"""
END_DATE
"""
Sort vouchers by value.
"""
VALUE
"""
Sort vouchers by type.
"""
TYPE
"""
Sort vouchers by usage limit.
"""
USAGE_LIMIT
"""
Sort vouchers by minimum spent amount.
"""
MINIMUM_SPENT_AMOUNT
}
"""
Represents a job data of exported file.
"""
type ExportFile implements Node & Job {
"""
The ID of the object.
"""
id: ID!
user: User
app: App
"""
Job status.
"""
status: JobStatusEnum!
"""
Created date time of job in ISO 8601 format.
"""
createdAt: DateTime!
"""
Date time of job last update in ISO 8601 format.
"""
updatedAt: DateTime!
"""
Job message.
"""
message: String
"""
The URL of field to download.
"""
url: String
"""
List of events associated with the export.
"""
events: [ExportEvent!]
}
"""
History log of export file.
"""
type ExportEvent implements Node {
"""
The ID of the object.
"""
id: ID!
"""
Date when event happened at in ISO 8601 format.
"""
date: DateTime!
"""
Export event type.
"""
type: ExportEventsEnum!
"""
User who performed the action.
"""
user: User
"""
App which performed the action.
"""
app: App
"""
Content of the event.
"""
message: String!
}
"""
An enumeration.
"""
enum ExportEventsEnum {
EXPORT_PENDING
EXPORT_SUCCESS
EXPORT_FAILED
EXPORT_DELETED
EXPORTED_FILE_SENT
EXPORT_FAILED_INFO_SENT
}
type ExportFileCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [ExportFileCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type ExportFileCountableEdge {
"""
The item at the end of the edge.
"""
node: ExportFile!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input ExportFileFilterInput {
createdAt: DateTimeRangeInput
updatedAt: DateTimeRangeInput
status: JobStatusEnum
user: String
app: String
}
input ExportFileSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort export file by the selected field.
"""
field: ExportFileSortField!
}
enum ExportFileSortField {
"""
Sort export file by status.
"""
STATUS
"""
Sort export file by created at.
"""
CREATED_AT
"""
Sort export file by updated at.
"""
UPDATED_AT
}
type CheckoutCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [CheckoutCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type CheckoutCountableEdge {
"""
The item at the end of the edge.
"""
node: Checkout!
"""
A cursor for use in pagination.
"""
cursor: String!
}
type CheckoutLineCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [CheckoutLineCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type CheckoutLineCountableEdge {
"""
The item at the end of the edge.
"""
node: CheckoutLine!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input AttributeSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort attributes by the selected field.
"""
field: AttributeSortField!
}
enum AttributeSortField {
"""
Sort attributes by name
"""
NAME
"""
Sort attributes by slug
"""
SLUG
"""
Sort attributes by the value required flag
"""
VALUE_REQUIRED
"""
Sort attributes by the variant only flag
"""
IS_VARIANT_ONLY
"""
Sort attributes by visibility in the storefront
"""
VISIBLE_IN_STOREFRONT
"""
Sort attributes by the filterable in storefront flag
"""
FILTERABLE_IN_STOREFRONT
"""
Sort attributes by the filterable in dashboard flag
"""
FILTERABLE_IN_DASHBOARD
"""
Sort attributes by their position in storefront
"""
STOREFRONT_SEARCH_POSITION
"""
Sort attributes based on whether they can be displayed or not in a product grid.
"""
AVAILABLE_IN_GRID
}
"""
Represents ongoing installation of app.
"""
type AppInstallation implements Node & Job {
appName: String!
manifestUrl: String!
"""
The ID of the object.
"""
id: ID!
"""
Job status.
"""
status: JobStatusEnum!
"""
Created date time of job in ISO 8601 format.
"""
createdAt: DateTime!
"""
Date time of job last update in ISO 8601 format.
"""
updatedAt: DateTime!
"""
Job message.
"""
message: String
}
type AppCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [AppCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type AppCountableEdge {
"""
The item at the end of the edge.
"""
node: App!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input AppFilterInput {
search: String
isActive: Boolean
type: AppTypeEnum
}
input AppSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort apps by the selected field.
"""
field: AppSortField!
}
enum AppSortField {
"""
Sort apps by name.
"""
NAME
"""
Sort apps by creation date.
"""
CREATION_DATE
}
type AddressValidationData {
countryCode: String
countryName: String
addressFormat: String
addressLatinFormat: String
allowedFields: [String]
requiredFields: [String]
upperFields: [String]
countryAreaType: String
countryAreaChoices: [ChoiceValue]
cityType: String
cityChoices: [ChoiceValue]
cityAreaType: String
cityAreaChoices: [ChoiceValue]
postalCodeType: String
postalCodeMatchers: [String]
postalCodeExamples: [String]
postalCodePrefix: String
}
type ChoiceValue {
raw: String
verbose: String
}
type UserCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [UserCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type UserCountableEdge {
"""
The item at the end of the edge.
"""
node: User!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input CustomerFilterInput {
dateJoined: DateRangeInput
numberOfOrders: IntRangeInput
placedOrders: DateRangeInput
search: String
}
input UserSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort users by the selected field.
"""
field: UserSortField!
}
enum UserSortField {
"""
Sort users by first name.
"""
FIRST_NAME
"""
Sort users by last name.
"""
LAST_NAME
"""
Sort users by email.
"""
EMAIL
"""
Sort users by order count.
"""
ORDER_COUNT
}
type GroupCountableConnection {
"""
Pagination data for this connection.
"""
pageInfo: PageInfo!
edges: [GroupCountableEdge!]!
"""
A total count of items in the collection.
"""
totalCount: Int
}
type GroupCountableEdge {
"""
The item at the end of the edge.
"""
node: Group!
"""
A cursor for use in pagination.
"""
cursor: String!
}
input PermissionGroupFilterInput {
search: String
}
input PermissionGroupSortingInput {
"""
Specifies the direction in which to sort products.
"""
direction: OrderDirection!
"""
Sort permission group by the selected field.
"""
field: PermissionGroupSortField!
}
enum PermissionGroupSortField {
"""
Sort permission group accounts by name.
"""
NAME
}
input StaffUserInput {
status: StaffMemberStatus
search: String
}
enum StaffMemberStatus {
"""
User account has been activated.
"""
ACTIVE
"""
User account has not been activated yet.
"""
DEACTIVATED
}
union _Entity =
Address
| User
| Group
| App
| ProductVariant
| Product
| ProductType
| Collection
| Category
| ProductMedia
| ProductImage
| PageType
"""
Anything
"""
scalar _Any
type _Service {
sdl: String
}
type Mutation {
"""
Creates a new webhook subscription.
"""
webhookCreate(
"""
Fields required to create a webhook.
"""
input: WebhookCreateInput!
): WebhookCreate
"""
Deletes a webhook subscription.
"""
webhookDelete(
"""
ID of a webhook to delete.
"""
id: ID!
): WebhookDelete
"""
Updates a webhook subscription.
"""
webhookUpdate(
"""
ID of a webhook to update.
"""
id: ID!
"""
Fields required to update a webhook.
"""
input: WebhookUpdateInput!
): WebhookUpdate
"""
Creates new warehouse.
"""
createWarehouse(
"""
Fields required to create warehouse.
"""
input: WarehouseCreateInput!
): WarehouseCreate
"""
Updates given warehouse.
"""
updateWarehouse(
"""
ID of a warehouse to update.
"""
id: ID!
"""
Fields required to update warehouse.
"""
input: WarehouseUpdateInput!
): WarehouseUpdate
"""
Deletes selected warehouse.
"""
deleteWarehouse(
"""
ID of a warehouse to delete.
"""
id: ID!
): WarehouseDelete
"""
Add shipping zone to given warehouse.
"""
assignWarehouseShippingZone(
"""
ID of a warehouse to update.
"""
id: ID!
"""
List of shipping zone IDs.
"""
shippingZoneIds: [ID!]!
): WarehouseShippingZoneAssign
"""
Remove shipping zone from given warehouse.
"""
unassignWarehouseShippingZone(
"""
ID of a warehouse to update.
"""
id: ID!
"""
List of shipping zone IDs.
"""
shippingZoneIds: [ID!]!
): WarehouseShippingZoneUnassign
"""
Creates a new staff notification recipient.
"""
staffNotificationRecipientCreate(
"""
Fields required to create a staff notification recipient.
"""
input: StaffNotificationRecipientInput!
): StaffNotificationRecipientCreate
"""
Updates a staff notification recipient.
"""
staffNotificationRecipientUpdate(
"""
ID of a staff notification recipient to update.
"""
id: ID!
"""
Fields required to update a staff notification recipient.
"""
input: StaffNotificationRecipientInput!
): StaffNotificationRecipientUpdate
"""
Delete staff notification recipient.
"""
staffNotificationRecipientDelete(
"""
ID of a staff notification recipient to delete.
"""
id: ID!
): StaffNotificationRecipientDelete
"""
Updates site domain of the shop.
"""
shopDomainUpdate(
"""
Fields required to update site.
"""
input: SiteDomainInput
): ShopDomainUpdate
"""
Updates shop settings.
"""
shopSettingsUpdate(
"""
Fields required to update shop settings.
"""
input: ShopSettingsInput!
): ShopSettingsUpdate
"""
Fetch tax rates.
"""
shopFetchTaxRates: ShopFetchTaxRates
"""
Creates/Updates translations for Shop Settings.
"""
shopSettingsTranslate(
"""
Fields required to update shop settings translations.
"""
input: ShopSettingsTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): ShopSettingsTranslate
"""
Update the shop's address. If the `null` value is passed, the currently selected address will be deleted.
"""
shopAddressUpdate(
"""
Fields required to update shop address.
"""
input: AddressInput
): ShopAddressUpdate
"""
Update shop order settings.
"""
orderSettingsUpdate(
"""
Fields required to update shop order settings.
"""
input: OrderSettingsUpdateInput!
): OrderSettingsUpdate
"""
Manage shipping method's availability in channels.
"""
shippingMethodChannelListingUpdate(
"""
ID of a shipping method to update.
"""
id: ID!
"""
Fields required to update shipping method channel listings.
"""
input: ShippingMethodChannelListingInput!
): ShippingMethodChannelListingUpdate
"""
Creates a new shipping price.
"""
shippingPriceCreate(
"""
Fields required to create a shipping price.
"""
input: ShippingPriceInput!
): ShippingPriceCreate
"""
Deletes a shipping price.
"""
shippingPriceDelete(
"""
ID of a shipping price to delete.
"""
id: ID!
): ShippingPriceDelete
"""
Deletes shipping prices.
"""
shippingPriceBulkDelete(
"""
List of shipping price IDs to delete.
"""
ids: [ID]!
): ShippingPriceBulkDelete
"""
Updates a new shipping price.
"""
shippingPriceUpdate(
"""
ID of a shipping price to update.
"""
id: ID!
"""
Fields required to update a shipping price.
"""
input: ShippingPriceInput!
): ShippingPriceUpdate
"""
Creates/Updates translations for shipping method.
"""
shippingPriceTranslate(
"""
Shipping method ID.
"""
id: ID!
input: ShippingPriceTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): ShippingPriceTranslate
"""
Exclude products from shipping price.
"""
shippingPriceExcludeProducts(
"""
ID of a shipping price.
"""
id: ID!
"""
Exclude products input.
"""
input: ShippingPriceExcludeProductsInput!
): ShippingPriceExcludeProducts
"""
Remove product from excluded list for shipping price.
"""
shippingPriceRemoveProductFromExclude(
"""
ID of a shipping price.
"""
id: ID!
"""
List of products which will be removed from excluded list.
"""
products: [ID]!
): ShippingPriceRemoveProductFromExclude
"""
Creates a new shipping zone.
"""
shippingZoneCreate(
"""
Fields required to create a shipping zone.
"""
input: ShippingZoneCreateInput!
): ShippingZoneCreate
"""
Deletes a shipping zone.
"""
shippingZoneDelete(
"""
ID of a shipping zone to delete.
"""
id: ID!
): ShippingZoneDelete
"""
Deletes shipping zones.
"""
shippingZoneBulkDelete(
"""
List of shipping zone IDs to delete.
"""
ids: [ID]!
): ShippingZoneBulkDelete
"""
Updates a new shipping zone.
"""
shippingZoneUpdate(
"""
ID of a shipping zone to update.
"""
id: ID!
"""
Fields required to update a shipping zone.
"""
input: ShippingZoneUpdateInput!
): ShippingZoneUpdate
"""
Assign attributes to a given product type.
"""
productAttributeAssign(
"""
The operations to perform.
"""
operations: [ProductAttributeAssignInput]!
"""
ID of the product type to assign the attributes into.
"""
productTypeId: ID!
): ProductAttributeAssign
"""
Un-assign attributes from a given product type.
"""
productAttributeUnassign(
"""
The IDs of the attributes to unassign.
"""
attributeIds: [ID]!
"""
ID of the product type from which the attributes should be unassigned.
"""
productTypeId: ID!
): ProductAttributeUnassign
"""
Creates a new category.
"""
categoryCreate(
"""
Fields required to create a category.
"""
input: CategoryInput!
"""
ID of the parent category. If empty, category will be top level category.
"""
parent: ID
): CategoryCreate
"""
Deletes a category.
"""
categoryDelete(
"""
ID of a category to delete.
"""
id: ID!
): CategoryDelete
"""
Deletes categories.
"""
categoryBulkDelete(
"""
List of category IDs to delete.
"""
ids: [ID]!
): CategoryBulkDelete
"""
Updates a category.
"""
categoryUpdate(
"""
ID of a category to update.
"""
id: ID!
"""
Fields required to update a category.
"""
input: CategoryInput!
): CategoryUpdate
"""
Creates/Updates translations for Category.
"""
categoryTranslate(
"""
Category ID.
"""
id: ID!
input: TranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): CategoryTranslate
"""
Adds products to a collection.
"""
collectionAddProducts(
"""
ID of a collection.
"""
collectionId: ID!
"""
List of product IDs.
"""
products: [ID]!
): CollectionAddProducts
"""
Creates a new collection.
"""
collectionCreate(
"""
Fields required to create a collection.
"""
input: CollectionCreateInput!
): CollectionCreate
"""
Deletes a collection.
"""
collectionDelete(
"""
ID of a collection to delete.
"""
id: ID!
): CollectionDelete
"""
Reorder the products of a collection.
"""
collectionReorderProducts(
"""
ID of a collection.
"""
collectionId: ID!
"""
The collection products position operations.
"""
moves: [MoveProductInput]!
): CollectionReorderProducts
"""
Deletes collections.
"""
collectionBulkDelete(
"""
List of collection IDs to delete.
"""
ids: [ID]!
): CollectionBulkDelete
"""
Remove products from a collection.
"""
collectionRemoveProducts(
"""
ID of a collection.
"""
collectionId: ID!
"""
List of product IDs.
"""
products: [ID]!
): CollectionRemoveProducts
"""
Updates a collection.
"""
collectionUpdate(
"""
ID of a collection to update.
"""
id: ID!
"""
Fields required to update a collection.
"""
input: CollectionInput!
): CollectionUpdate
"""
Creates/Updates translations for collection.
"""
collectionTranslate(
"""
Collection ID.
"""
id: ID!
input: TranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): CollectionTranslate
"""
Manage collection's availability in channels.
"""
collectionChannelListingUpdate(
"""
ID of a collection to update.
"""
id: ID!
"""
Fields required to create or update collection channel listings.
"""
input: CollectionChannelListingUpdateInput!
): CollectionChannelListingUpdate
"""
Creates a new product.
"""
productCreate(
"""
Fields required to create a product.
"""
input: ProductCreateInput!
): ProductCreate
"""
Deletes a product.
"""
productDelete(
"""
ID of a product to delete.
"""
id: ID!
): ProductDelete
"""
Deletes products.
"""
productBulkDelete(
"""
List of product IDs to delete.
"""
ids: [ID]!
): ProductBulkDelete
"""
Updates an existing product.
"""
productUpdate(
"""
ID of a product to update.
"""
id: ID!
"""
Fields required to update a product.
"""
input: ProductInput!
): ProductUpdate
"""
Creates/Updates translations for Product.
"""
productTranslate(
"""
Product ID.
"""
id: ID!
input: TranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): ProductTranslate
"""
Manage product's availability in channels.
"""
productChannelListingUpdate(
"""
ID of a product to update.
"""
id: ID!
"""
Fields required to create or update product channel listings.
"""
input: ProductChannelListingUpdateInput!
): ProductChannelListingUpdate
"""
Create a media object (image or video URL) associated with product. For 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
"""
productMediaCreate(
"""
Fields required to create a product media.
"""
input: ProductMediaCreateInput!
): ProductMediaCreate
"""
Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.
"""
productVariantReorder(
"""
The list of variant reordering operations.
"""
moves: [ReorderInput]!
"""
Id of product that variants order will be altered.
"""
productId: ID!
): ProductVariantReorder
"""
Deletes a product media.
"""
productMediaDelete(
"""
ID of a product media to delete.
"""
id: ID!
): ProductMediaDelete
"""
Deletes product media.
"""
productMediaBulkDelete(
"""
List of product media IDs to delete.
"""
ids: [ID]!
): ProductMediaBulkDelete
"""
Changes ordering of the product media.
"""
productMediaReorder(
"""
IDs of a product media in the desired order.
"""
mediaIds: [ID]!
"""
ID of product that media order will be altered.
"""
productId: ID!
): ProductMediaReorder
"""
Updates a product media.
"""
productMediaUpdate(
"""
ID of a product media to update.
"""
id: ID!
"""
Fields required to update a product media.
"""
input: ProductMediaUpdateInput!
): ProductMediaUpdate
"""
Creates a new product type.
"""
productTypeCreate(
"""
Fields required to create a product type.
"""
input: ProductTypeInput!
): ProductTypeCreate
"""
Deletes a product type.
"""
productTypeDelete(
"""
ID of a product type to delete.
"""
id: ID!
): ProductTypeDelete
"""
Deletes product types.
"""
productTypeBulkDelete(
"""
List of product type IDs to delete.
"""
ids: [ID]!
): ProductTypeBulkDelete
"""
Updates an existing product type.
"""
productTypeUpdate(
"""
ID of a product type to update.
"""
id: ID!
"""
Fields required to update a product type.
"""
input: ProductTypeInput!
): ProductTypeUpdate
"""
Reorder the attributes of a product type.
"""
productTypeReorderAttributes(
"""
The list of attribute reordering operations.
"""
moves: [ReorderInput]!
"""
ID of a product type.
"""
productTypeId: ID!
"""
The attribute type to reorder.
"""
type: ProductAttributeType!
): ProductTypeReorderAttributes
"""
Reorder product attribute values.
"""
productReorderAttributeValues(
"""
ID of an attribute.
"""
attributeId: ID!
"""
The list of reordering operations for given attribute values.
"""
moves: [ReorderInput]!
"""
ID of a product.
"""
productId: ID!
): ProductReorderAttributeValues
"""
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
"""
digitalContentCreate(
"""
Fields required to create a digital content.
"""
input: DigitalContentUploadInput!
"""
ID of a product variant to upload digital content.
"""
variantId: ID!
): DigitalContentCreate
"""
Remove digital content assigned to given variant.
"""
digitalContentDelete(
"""
ID of a product variant with digital content to remove.
"""
variantId: ID!
): DigitalContentDelete
"""
Update digital content.
"""
digitalContentUpdate(
"""
Fields required to update a digital content.
"""
input: DigitalContentInput!
"""
ID of a product variant with digital content to update.
"""
variantId: ID!
): DigitalContentUpdate
"""
Generate new URL to digital content.
"""
digitalContentUrlCreate(
"""
Fields required to create a new url.
"""
input: DigitalContentUrlCreateInput!
): DigitalContentUrlCreate
"""
Creates a new variant for a product.
"""
productVariantCreate(
"""
Fields required to create a product variant.
"""
input: ProductVariantCreateInput!
): ProductVariantCreate
"""
Deletes a product variant.
"""
productVariantDelete(
"""
ID of a product variant to delete.
"""
id: ID!
): ProductVariantDelete
"""
Creates product variants for a given product.
"""
productVariantBulkCreate(
"""
ID of the product to create the variants for.
"""
product: ID!
"""
Input list of product variants to create.
"""
variants: [ProductVariantBulkCreateInput]!
): ProductVariantBulkCreate
"""
Deletes product variants.
"""
productVariantBulkDelete(
"""
List of product variant IDs to delete.
"""
ids: [ID]!
): ProductVariantBulkDelete
"""
Creates stocks for product variant.
"""
productVariantStocksCreate(
"""
Input list of stocks to create.
"""
stocks: [StockInput!]!
"""
ID of a product variant for which stocks will be created.
"""
variantId: ID!
): ProductVariantStocksCreate
"""
Delete stocks from product variant.
"""
productVariantStocksDelete(
"""
ID of product variant for which stocks will be deleted.
"""
variantId: ID!
warehouseIds: [ID!]
): ProductVariantStocksDelete
"""
Update stocks for product variant.
"""
productVariantStocksUpdate(
"""
Input list of stocks to create.
"""
stocks: [StockInput!]!
"""
ID of a product variant for which stocks will be created.
"""
variantId: ID!
): ProductVariantStocksUpdate
"""
Updates an existing variant for product.
"""
productVariantUpdate(
"""
ID of a product variant to update.
"""
id: ID!
"""
Fields required to update a product variant.
"""
input: ProductVariantInput!
): ProductVariantUpdate
"""
Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
"""
productVariantSetDefault(
"""
Id of a product that will have the default variant set.
"""
productId: ID!
"""
Id of a variant that will be set as default.
"""
variantId: ID!
): ProductVariantSetDefault
"""
Creates/Updates translations for Product Variant.
"""
productVariantTranslate(
"""
Product Variant ID.
"""
id: ID!
input: NameTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): ProductVariantTranslate
"""
Manage product variant prices in channels.
"""
productVariantChannelListingUpdate(
"""
ID of a product variant to update.
"""
id: ID!
"""
('List of fields required to create or upgrade product variant ', 'channel listings.')
"""
input: [ProductVariantChannelListingAddInput!]!
): ProductVariantChannelListingUpdate
"""
Reorder product variant attribute values.
"""
productVariantReorderAttributeValues(
"""
ID of an attribute.
"""
attributeId: ID!
"""
The list of reordering operations for given attribute values.
"""
moves: [ReorderInput]!
"""
ID of a product variant.
"""
variantId: ID!
): ProductVariantReorderAttributeValues
"""
Assign an media to a product variant.
"""
variantMediaAssign(
"""
ID of a product media to assign to a variant.
"""
mediaId: ID!
"""
ID of a product variant.
"""
variantId: ID!
): VariantMediaAssign
"""
Unassign an media from a product variant.
"""
variantMediaUnassign(
"""
ID of a product media to unassign from a variant.
"""
mediaId: ID!
"""
ID of a product variant.
"""
variantId: ID!
): VariantMediaUnassign
"""
Captures the authorized payment amount.
"""
paymentCapture(
"""
Transaction amount.
"""
amount: PositiveDecimal
"""
Payment ID.
"""
paymentId: ID!
): PaymentCapture
"""
Refunds the captured payment amount.
"""
paymentRefund(
"""
Transaction amount.
"""
amount: PositiveDecimal
"""
Payment ID.
"""
paymentId: ID!
): PaymentRefund
"""
Voids the authorized payment.
"""
paymentVoid(
"""
Payment ID.
"""
paymentId: ID!
): PaymentVoid
"""
Initializes payment process when it is required by gateway.
"""
paymentInitialize(
"""
A gateway name used to initialize the payment.
"""
gateway: String!
"""
Client-side generated data required to initialize the payment.
"""
paymentData: JSONString
): PaymentInitialize
"""
Creates a new page.
"""
pageCreate(
"""
Fields required to create a page.
"""
input: PageCreateInput!
): PageCreate
"""
Deletes a page.
"""
pageDelete(
"""
ID of a page to delete.
"""
id: ID!
): PageDelete
"""
Deletes pages.
"""
pageBulkDelete(
"""
List of page IDs to delete.
"""
ids: [ID]!
): PageBulkDelete
"""
Publish pages.
"""
pageBulkPublish(
"""
List of page IDs to (un)publish.
"""
ids: [ID]!
"""
Determine if pages will be published or not.
"""
isPublished: Boolean!
): PageBulkPublish
"""
Updates an existing page.
"""
pageUpdate(
"""
ID of a page to update.
"""
id: ID!
"""
Fields required to update a page.
"""
input: PageInput!
): PageUpdate
"""
Creates/Updates translations for Page.
"""
pageTranslate(
"""
Page ID.
"""
id: ID!
input: PageTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): PageTranslate
"""
Create a new page type.
"""
pageTypeCreate(
"""
Fields required to create page type.
"""
input: PageTypeCreateInput!
): PageTypeCreate
"""
Update page type.
"""
pageTypeUpdate(
"""
ID of the page type to update.
"""
id: ID
"""
Fields required to update page type.
"""
input: PageTypeUpdateInput!
): PageTypeUpdate
"""
Delete a page type.
"""
pageTypeDelete(
"""
ID of the page type to delete.
"""
id: ID!
): PageTypeDelete
"""
Delete page types.
"""
pageTypeBulkDelete(
"""
List of page type IDs to delete
"""
ids: [ID!]!
): PageTypeBulkDelete
"""
Assign attributes to a given page type.
"""
pageAttributeAssign(
"""
The IDs of the attributes to assign.
"""
attributeIds: [ID!]!
"""
ID of the page type to assign the attributes into.
"""
pageTypeId: ID!
): PageAttributeAssign
"""
Unassign attributes from a given page type.
"""
pageAttributeUnassign(
"""
The IDs of the attributes to unassign.
"""
attributeIds: [ID!]!
"""
ID of the page type from which the attributes should be unassign.
"""
pageTypeId: ID!
): PageAttributeUnassign
"""
Reorder the attributes of a page type.
"""
pageTypeReorderAttributes(
"""
The list of attribute reordering operations.
"""
moves: [ReorderInput!]!
"""
ID of a page type.
"""
pageTypeId: ID!
): PageTypeReorderAttributes
"""
Reorder page attribute values.
"""
pageReorderAttributeValues(
"""
ID of an attribute.
"""
attributeId: ID!
"""
The list of reordering operations for given attribute values.
"""
moves: [ReorderInput]!
"""
ID of a page.
"""
pageId: ID!
): PageReorderAttributeValues
"""
Completes creating an order.
"""
draftOrderComplete(
"""
ID of the order that will be completed.
"""
id: ID!
): DraftOrderComplete
"""
Creates a new draft order.
"""
draftOrderCreate(
"""
Fields required to create an order.
"""
input: DraftOrderCreateInput!
): DraftOrderCreate
"""
Deletes a draft order.
"""
draftOrderDelete(
"""
ID of a draft order to delete.
"""
id: ID!
): DraftOrderDelete
"""
Deletes draft orders.
"""
draftOrderBulkDelete(
"""
List of draft order IDs to delete.
"""
ids: [ID]!
): DraftOrderBulkDelete
"""
Deletes order lines.
"""
draftOrderLinesBulkDelete(
"""
List of order lines IDs to delete.
"""
ids: [ID]!
): DraftOrderLinesBulkDelete
"""
Updates a draft order.
"""
draftOrderUpdate(
"""
ID of a draft order to update.
"""
id: ID!
"""
Fields required to update an order.
"""
input: DraftOrderInput!
): DraftOrderUpdate
"""
Adds note to the order.
"""
orderAddNote(
"""
ID of the order to add a note for.
"""
order: ID!
"""
Fields required to create a note for the order.
"""
input: OrderAddNoteInput!
): OrderAddNote
"""
Cancel an order.
"""
orderCancel(
"""
ID of the order to cancel.
"""
id: ID!
): OrderCancel
"""
Capture an order.
"""
orderCapture(
"""
Amount of money to capture.
"""
amount: PositiveDecimal!
"""
ID of the order to capture.
"""
id: ID!
): OrderCapture
"""
Confirms an unconfirmed order by changing status to unfulfilled.
"""
orderConfirm(
"""
ID of an order to confirm.
"""
id: ID!
): OrderConfirm
"""
Creates new fulfillments for an order.
"""
orderFulfill(
"""
Fields required to create an fulfillment.
"""
input: OrderFulfillInput!
"""
ID of the order to be fulfilled.
"""
order: ID
): OrderFulfill
"""
Cancels existing fulfillment and optionally restocks items.
"""
orderFulfillmentCancel(
"""
ID of an fulfillment to cancel.
"""
id: ID!
"""
Fields required to cancel an fulfillment.
"""
input: FulfillmentCancelInput!
): FulfillmentCancel
"""
Updates a fulfillment for an order.
"""
orderFulfillmentUpdateTracking(
"""
ID of an fulfillment to update.
"""
id: ID!
"""
Fields required to update an fulfillment.
"""
input: FulfillmentUpdateTrackingInput!
): FulfillmentUpdateTracking
"""
Refund products.
"""
orderFulfillmentRefundProducts(
"""
Fields required to create an refund fulfillment.
"""
input: OrderRefundProductsInput!
"""
ID of the order to be refunded.
"""
order: ID!
): FulfillmentRefundProducts
"""
Return products.
"""
orderFulfillmentReturnProducts(
"""
Fields required to return products.
"""
input: OrderReturnProductsInput!
"""
ID of the order to be returned.
"""
order: ID!
): FulfillmentReturnProducts
"""
Create order lines for an order.
"""
orderLinesCreate(
"""
ID of the order to add the lines to.
"""
id: ID!
"""
Fields required to add order lines.
"""
input: [OrderLineCreateInput]!
): OrderLinesCreate
"""
Deletes an order line from an order.
"""
orderLineDelete(
"""
ID of the order line to delete.
"""
id: ID!
): OrderLineDelete
"""
Updates an order line of an order.
"""
orderLineUpdate(
"""
ID of the order line to update.
"""
id: ID!
"""
Fields required to update an order line.
"""
input: OrderLineInput!
): OrderLineUpdate
"""
Adds discount to the order.
"""
orderDiscountAdd(
"""
Fields required to create a discount for the order.
"""
input: OrderDiscountCommonInput!
"""
ID of an order to discount.
"""
orderId: ID!
): OrderDiscountAdd
"""
Update discount for the order.
"""
orderDiscountUpdate(
"""
ID of a discount to update.
"""
discountId: ID!
"""
Fields required to update a discount for the order.
"""
input: OrderDiscountCommonInput!
): OrderDiscountUpdate
"""
Remove discount from the order.
"""
orderDiscountDelete(
"""
ID of a discount to remove.
"""
discountId: ID!
): OrderDiscountDelete
"""
Update discount for the order line.
"""
orderLineDiscountUpdate(
"""
Fields required to update price for the order line.
"""
input: OrderDiscountCommonInput!
"""
ID of a order line to update price
"""
orderLineId: ID!
): OrderLineDiscountUpdate
"""
Remove discount applied to the order line.
"""
orderLineDiscountRemove(
"""
ID of a order line to remove its discount
"""
orderLineId: ID!
): OrderLineDiscountRemove
"""
Mark order as manually paid.
"""
orderMarkAsPaid(
"""
ID of the order to mark paid.
"""
id: ID!
"""
The external transaction reference.
"""
transactionReference: String
): OrderMarkAsPaid
"""
Refund an order.
"""
orderRefund(
"""
Amount of money to refund.
"""
amount: PositiveDecimal!
"""
ID of the order to refund.
"""
id: ID!
): OrderRefund
"""
Updates an order.
"""
orderUpdate(
"""
ID of an order to update.
"""
id: ID!
"""
Fields required to update an order.
"""
input: OrderUpdateInput!
): OrderUpdate
"""
Updates a shipping method of the order.
"""
orderUpdateShipping(
"""
ID of the order to update a shipping method.
"""
order: ID!
"""
Fields required to change shipping method of the order.
"""
input: OrderUpdateShippingInput
): OrderUpdateShipping
"""
Void an order.
"""
orderVoid(
"""
ID of the order to void.
"""
id: ID!
): OrderVoid
"""
Cancels orders.
"""
orderBulkCancel(
"""
List of orders IDs to cancel.
"""
ids: [ID]!
): OrderBulkCancel
"""
Delete metadata of an object.
"""
deleteMetadata(
"""
ID of an object to update.
"""
id: ID!
"""
Metadata keys to delete.
"""
keys: [String!]!
): DeleteMetadata
"""
Delete object's private metadata.
"""
deletePrivateMetadata(
"""
ID of an object to update.
"""
id: ID!
"""
Metadata keys to delete.
"""
keys: [String!]!
): DeletePrivateMetadata
"""
Updates metadata of an object.
"""
updateMetadata(
"""
ID of an object to update.
"""
id: ID!
"""
Fields required to update the object's metadata.
"""
input: [MetadataInput!]!
): UpdateMetadata
"""
Updates private metadata of an object.
"""
updatePrivateMetadata(
"""
ID of an object to update.
"""
id: ID!
"""
Fields required to update the object's metadata.
"""
input: [MetadataInput!]!
): UpdatePrivateMetadata
"""
Assigns storefront's navigation menus.
"""
assignNavigation(
"""
ID of the menu.
"""
menu: ID
"""
Type of the navigation bar to assign the menu to.
"""
navigationType: NavigationType!
): AssignNavigation
"""
Creates a new Menu.
"""
menuCreate(
"""
Fields required to create a menu.
"""
input: MenuCreateInput!
): MenuCreate
"""
Deletes a menu.
"""
menuDelete(
"""
ID of a menu to delete.
"""
id: ID!
): MenuDelete
"""
Deletes menus.
"""
menuBulkDelete(
"""
List of menu IDs to delete.
"""
ids: [ID]!
): MenuBulkDelete
"""
Updates a menu.
"""
menuUpdate(
"""
ID of a menu to update.
"""
id: ID!
"""
Fields required to update a menu.
"""
input: MenuInput!
): MenuUpdate
"""
Creates a new menu item.
"""
menuItemCreate(
"""
Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
"""
input: MenuItemCreateInput!
): MenuItemCreate
"""
Deletes a menu item.
"""
menuItemDelete(
"""
ID of a menu item to delete.
"""
id: ID!
): MenuItemDelete
"""
Deletes menu items.
"""
menuItemBulkDelete(
"""
List of menu item IDs to delete.
"""
ids: [ID]!
): MenuItemBulkDelete
"""
Updates a menu item.
"""
menuItemUpdate(
"""
ID of a menu item to update.
"""
id: ID!
"""
Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
"""
input: MenuItemInput!
): MenuItemUpdate
"""
Creates/Updates translations for Menu Item.
"""
menuItemTranslate(
"""
Menu Item ID.
"""
id: ID!
input: NameTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): MenuItemTranslate
"""
Moves items of menus.
"""
menuItemMove(
"""
ID of the menu.
"""
menu: ID!
"""
The menu position data.
"""
moves: [MenuItemMoveInput]!
): MenuItemMove
"""
Request an invoice for the order using plugin.
"""
invoiceRequest(
"""
Invoice number, if not provided it will be generated.
"""
number: String
"""
ID of the order related to invoice.
"""
orderId: ID!
): InvoiceRequest
"""
Requests deletion of an invoice.
"""
invoiceRequestDelete(
"""
ID of an invoice to request the deletion.
"""
id: ID!
): InvoiceRequestDelete
"""
Creates a ready to send invoice.
"""
invoiceCreate(
"""
Fields required when creating an invoice.
"""
input: InvoiceCreateInput!
"""
ID of the order related to invoice.
"""
orderId: ID!
): InvoiceCreate
"""
Deletes an invoice.
"""
invoiceDelete(
"""
ID of an invoice to delete.
"""
id: ID!
): InvoiceDelete
"""
Updates an invoice.
"""
invoiceUpdate(
"""
ID of an invoice to update.
"""
id: ID!
"""
Fields to use when updating an invoice.
"""
input: UpdateInvoiceInput!
): InvoiceUpdate
"""
Send an invoice notification to the customer.
"""
invoiceSendNotification(
"""
ID of an invoice to be sent.
"""
id: ID!
): InvoiceSendNotification
"""
Activate a gift card.
"""
giftCardActivate(
"""
ID of a gift card to activate.
"""
id: ID!
): GiftCardActivate
"""
Creates a new gift card.
"""
giftCardCreate(
"""
Fields required to create a gift card.
"""
input: GiftCardCreateInput!
): GiftCardCreate
"""
Deactivate a gift card.
"""
giftCardDeactivate(
"""
ID of a gift card to deactivate.
"""
id: ID!
): GiftCardDeactivate
"""
Update a gift card.
"""
giftCardUpdate(
"""
ID of a gift card to update.
"""
id: ID!
"""
Fields required to update a gift card.
"""
input: GiftCardUpdateInput!
): GiftCardUpdate
"""
Update plugin configuration.
"""
pluginUpdate(
"""
ID of plugin to update.
"""
id: ID!
"""
Fields required to update a plugin configuration.
"""
input: PluginUpdateInput!
): PluginUpdate
"""
Creates a new sale.
"""
saleCreate(
"""
Fields required to create a sale.
"""
input: SaleInput!
): SaleCreate
"""
Deletes a sale.
"""
saleDelete(
"""
ID of a sale to delete.
"""
id: ID!
): SaleDelete
"""
Deletes sales.
"""
saleBulkDelete(
"""
List of sale IDs to delete.
"""
ids: [ID]!
): SaleBulkDelete
"""
Updates a sale.
"""
saleUpdate(
"""
ID of a sale to update.
"""
id: ID!
"""
Fields required to update a sale.
"""
input: SaleInput!
): SaleUpdate
"""
Adds products, categories, collections to a voucher.
"""
saleCataloguesAdd(
"""
ID of a sale.
"""
id: ID!
"""
Fields required to modify catalogue IDs of sale.
"""
input: CatalogueInput!
): SaleAddCatalogues
"""
Removes products, categories, collections from a sale.
"""
saleCataloguesRemove(
"""
ID of a sale.
"""
id: ID!
"""
Fields required to modify catalogue IDs of sale.
"""
input: CatalogueInput!
): SaleRemoveCatalogues
"""
Creates/updates translations for a sale.
"""
saleTranslate(
"""
Voucher ID.
"""
id: ID!
input: NameTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): SaleTranslate
"""
Manage sale's availability in channels.
"""
saleChannelListingUpdate(
"""
ID of a sale to update.
"""
id: ID!
"""
Fields required to update sale channel listings.
"""
input: SaleChannelListingInput!
): SaleChannelListingUpdate
"""
Creates a new voucher.
"""
voucherCreate(
"""
Fields required to create a voucher.
"""
input: VoucherInput!
): VoucherCreate
"""
Deletes a voucher.
"""
voucherDelete(
"""
ID of a voucher to delete.
"""
id: ID!
): VoucherDelete
"""
Deletes vouchers.
"""
voucherBulkDelete(
"""
List of voucher IDs to delete.
"""
ids: [ID]!
): VoucherBulkDelete
"""
Updates a voucher.
"""
voucherUpdate(
"""
ID of a voucher to update.
"""
id: ID!
"""
Fields required to update a voucher.
"""
input: VoucherInput!
): VoucherUpdate
"""
Adds products, categories, collections to a voucher.
"""
voucherCataloguesAdd(
"""
ID of a voucher.
"""
id: ID!
"""
Fields required to modify catalogue IDs of voucher.
"""
input: CatalogueInput!
): VoucherAddCatalogues
"""
Removes products, categories, collections from a voucher.
"""
voucherCataloguesRemove(
"""
ID of a voucher.
"""
id: ID!
"""
Fields required to modify catalogue IDs of voucher.
"""
input: CatalogueInput!
): VoucherRemoveCatalogues
"""
Creates/Updates translations for Voucher.
"""
voucherTranslate(
"""
Voucher ID.
"""
id: ID!
input: NameTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): VoucherTranslate
"""
Manage voucher's availability in channels.
"""
voucherChannelListingUpdate(
"""
ID of a voucher to update.
"""
id: ID!
"""
Fields required to update voucher channel listings.
"""
input: VoucherChannelListingInput!
): VoucherChannelListingUpdate
"""
Export products to csv file.
"""
exportProducts(
"""
Fields required to export product data
"""
input: ExportProductsInput!
): ExportProducts
"""
Upload a file. 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
"""
fileUpload(
"""
Represents a file in a multipart request.
"""
file: Upload!
): FileUpload
"""
Adds a gift card or a voucher to a checkout.
"""
checkoutAddPromoCode(
"""
Checkout ID.
"""
checkoutId: ID!
"""
Gift card code or voucher code.
"""
promoCode: String!
): CheckoutAddPromoCode
"""
Update billing address in the existing checkout.
"""
checkoutBillingAddressUpdate(
"""
The billing address of the checkout.
"""
billingAddress: AddressInput!
"""
ID of the checkout.
"""
checkoutId: ID!
): CheckoutBillingAddressUpdate
"""
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.
"""
checkoutComplete(
"""
Checkout ID.
"""
checkoutId: ID!
"""
Client-side generated data required to finalize the payment.
"""
paymentData: JSONString
"""
URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.
"""
redirectUrl: String
"""
Determines whether to store the payment source for future usage.
"""
storeSource: Boolean = false
): CheckoutComplete
"""
Create a new checkout.
"""
checkoutCreate(
"""
Fields required to create checkout.
"""
input: CheckoutCreateInput!
): CheckoutCreate
"""
Sets the customer as the owner of the checkout.
"""
checkoutCustomerAttach(
"""
ID of the checkout.
"""
checkoutId: ID!
"""
[Deprecated] The ID of the customer. To identify a customer you should authenticate with JWT. This field will be removed after 2020-07-31.
"""
customerId: ID
): CheckoutCustomerAttach
"""
Removes the user assigned as the owner of the checkout.
"""
checkoutCustomerDetach(
"""
Checkout ID.
"""
checkoutId: ID!
): CheckoutCustomerDetach
"""
Updates email address in the existing checkout object.
"""
checkoutEmailUpdate(
"""
Checkout ID.
"""
checkoutId: ID
"""
email.
"""
email: String!
): CheckoutEmailUpdate
"""
Deletes a CheckoutLine.
"""
checkoutLineDelete(
"""
The ID of the checkout.
"""
checkoutId: ID!
"""
ID of the checkout line to delete.
"""
lineId: ID
): CheckoutLineDelete
"""
Adds a checkout line to the existing checkout.
"""
checkoutLinesAdd(
"""
The ID of the checkout.
"""
checkoutId: ID!
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLineInput]!
): CheckoutLinesAdd
"""
Updates checkout line in the existing checkout.
"""
checkoutLinesUpdate(
"""
The ID of the checkout.
"""
checkoutId: ID!
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLineInput]!
): CheckoutLinesUpdate
"""
Remove a gift card or a voucher from a checkout.
"""
checkoutRemovePromoCode(
"""
Checkout ID.
"""
checkoutId: ID!
"""
Gift card code or voucher code.
"""
promoCode: String!
): CheckoutRemovePromoCode
"""
Create a new payment for given checkout.
"""
checkoutPaymentCreate(
"""
Checkout ID.
"""
checkoutId: ID!
"""
Data required to create a new payment.
"""
input: PaymentInput!
): CheckoutPaymentCreate
"""
Update shipping address in the existing checkout.
"""
checkoutShippingAddressUpdate(
"""
ID of the checkout.
"""
checkoutId: ID!
"""
The mailing address to where the checkout will be shipped.
"""
shippingAddress: AddressInput!
): CheckoutShippingAddressUpdate
"""
Updates the shipping address of the checkout.
"""
checkoutShippingMethodUpdate(
"""
Checkout ID.
"""
checkoutId: ID
"""
Shipping method.
"""
shippingMethodId: ID!
): CheckoutShippingMethodUpdate
"""
Update language code in the existing checkout.
"""
checkoutLanguageCodeUpdate(
"""
ID of the checkout.
"""
checkoutId: ID!
"""
New language code.
"""
languageCode: LanguageCodeEnum!
): CheckoutLanguageCodeUpdate
"""
Creates new channel.
"""
channelCreate(
"""
Fields required to create channel.
"""
input: ChannelCreateInput!
): ChannelCreate
"""
Update a channel.
"""
channelUpdate(
"""
ID of a channel to update.
"""
id: ID!
"""
Fields required to update a channel.
"""
input: ChannelUpdateInput!
): ChannelUpdate
"""
Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.
"""
channelDelete(
"""
ID of a channel to delete.
"""
id: ID!
"""
Fields required to delete a channel.
"""
input: ChannelDeleteInput
): ChannelDelete
"""
Activate a channel.
"""
channelActivate(
"""
ID of the channel to activate.
"""
id: ID!
): ChannelActivate
"""
Deactivate a channel.
"""
channelDeactivate(
"""
ID of the channel to deactivate.
"""
id: ID!
): ChannelDeactivate
"""
Creates an attribute.
"""
attributeCreate(
"""
Fields required to create an attribute.
"""
input: AttributeCreateInput!
): AttributeCreate
"""
Deletes an attribute.
"""
attributeDelete(
"""
ID of an attribute to delete.
"""
id: ID!
): AttributeDelete
"""
Updates attribute.
"""
attributeUpdate(
"""
ID of an attribute to update.
"""
id: ID!
"""
Fields required to update an attribute.
"""
input: AttributeUpdateInput!
): AttributeUpdate
"""
Creates/Updates translations for attribute.
"""
attributeTranslate(
"""
Attribute ID.
"""
id: ID!
input: NameTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): AttributeTranslate
"""
Deletes attributes.
"""
attributeBulkDelete(
"""
List of attribute IDs to delete.
"""
ids: [ID]!
): AttributeBulkDelete
"""
Deletes values of attributes.
"""
attributeValueBulkDelete(
"""
List of attribute value IDs to delete.
"""
ids: [ID]!
): AttributeValueBulkDelete
"""
Creates a value for an attribute.
"""
attributeValueCreate(
"""
Attribute to which value will be assigned.
"""
attribute: ID!
"""
Fields required to create an AttributeValue.
"""
input: AttributeValueCreateInput!
): AttributeValueCreate
"""
Deletes a value of an attribute.
"""
attributeValueDelete(
"""
ID of a value to delete.
"""
id: ID!
): AttributeValueDelete
"""
Updates value of an attribute.
"""
attributeValueUpdate(
"""
ID of an AttributeValue to update.
"""
id: ID!
"""
Fields required to update an AttributeValue.
"""
input: AttributeValueCreateInput!
): AttributeValueUpdate
"""
Creates/Updates translations for attribute value.
"""
attributeValueTranslate(
"""
Attribute Value ID.
"""
id: ID!
input: AttributeValueTranslationInput!
"""
Translation language code.
"""
languageCode: LanguageCodeEnum!
): AttributeValueTranslate
"""
Reorder the values of an attribute.
"""
attributeReorderValues(
"""
ID of an attribute.
"""
attributeId: ID!
"""
The list of reordering operations for given attribute values.
"""
moves: [ReorderInput]!
): AttributeReorderValues
"""
Creates a new app.
"""
appCreate(
"""
Fields required to create a new app.
"""
input: AppInput!
): AppCreate
"""
Updates an existing app.
"""
appUpdate(
"""
ID of an app to update.
"""
id: ID!
"""
Fields required to update an existing app.
"""
input: AppInput!
): AppUpdate
"""
Deletes an app.
"""
appDelete(
"""
ID of an app to delete.
"""
id: ID!
): AppDelete
"""
Creates a new token.
"""
appTokenCreate(
"""
Fields required to create a new auth token.
"""
input: AppTokenInput!
): AppTokenCreate
"""
Deletes an authentication token assigned to app.
"""
appTokenDelete(
"""
ID of an auth token to delete.
"""
id: ID!
): AppTokenDelete
"""
Verify provided app token.
"""
appTokenVerify(
"""
App token to verify.
"""
token: String!
): AppTokenVerify
"""
Install new app by using app manifest.
"""
appInstall(
"""
Fields required to install a new app.
"""
input: AppInstallInput!
): AppInstall
"""
Retry failed installation of new app.
"""
appRetryInstall(
"""
Determine if app will be set active or not.
"""
activateAfterInstallation: Boolean = true
"""
ID of failed installation.
"""
id: ID!
): AppRetryInstall
"""
Delete failed installation.
"""
appDeleteFailedInstallation(
"""
ID of failed installation to delete.
"""
id: ID!
): AppDeleteFailedInstallation
"""
Fetch and validate manifest.
"""
appFetchManifest(manifestUrl: String!): AppFetchManifest
"""
Activate the app.
"""
appActivate(
"""
ID of app to activate.
"""
id: ID!
): AppActivate
"""
Deactivate the app.
"""
appDeactivate(
"""
ID of app to deactivate.
"""
id: ID!
): AppDeactivate
"""
Create JWT token.
"""
tokenCreate(
"""
Email of a user.
"""
email: String!
"""
Password of a user.
"""
password: String!
): CreateToken
"""
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.
"""
tokenRefresh(
"""
CSRF token required to refresh token. This argument is required when refreshToken is provided as a cookie.
"""
csrfToken: String
"""
Refresh token.
"""
refreshToken: String
): RefreshToken
"""
Verify JWT token.
"""
tokenVerify(
"""
JWT token to validate.
"""
token: String!
): VerifyToken
"""
Deactivate all JWT tokens of the currently authenticated user.
"""
tokensDeactivateAll: DeactivateAllUserTokens
"""
Prepare external authentication url for user by custom plugin.
"""
externalAuthenticationUrl(
"""
The data required by plugin to create external authentication url.
"""
input: JSONString!
"""
The ID of the authentication plugin.
"""
pluginId: String!
): ExternalAuthenticationUrl
"""
Obtain external access tokens for user by custom plugin.
"""
externalObtainAccessTokens(
"""
The data required by plugin to create authentication data.
"""
input: JSONString!
"""
The ID of the authentication plugin.
"""
pluginId: String!
): ExternalObtainAccessTokens
"""
Refresh user's access by custom plugin.
"""
externalRefresh(
"""
The data required by plugin to proceed the refresh process.
"""
input: JSONString!
"""
The ID of the authentication plugin.
"""
pluginId: String!
): ExternalRefresh
"""
Logout user by custom plugin.
"""
externalLogout(
"""
The data required by plugin to proceed the logout process.
"""
input: JSONString!
"""
The ID of the authentication plugin.
"""
pluginId: String!
): ExternalLogout
"""
Verify external authentication data by plugin.
"""
externalVerify(
"""
The data required by plugin to proceed the verification.
"""
input: JSONString!
"""
The ID of the authentication plugin.
"""
pluginId: String!
): ExternalVerify
"""
Sends an email with the account password modification link.
"""
requestPasswordReset(
"""
Email of the user that will be used for password recovery.
"""
email: String!
"""
URL of a view where users should be redirected to reset the password. URL in RFC 1808 format.
"""
redirectUrl: String!
): RequestPasswordReset
"""
Confirm user account with token sent by email during registration.
"""
confirmAccount(
"""
E-mail of the user performing account confirmation.
"""
email: String!
"""
A one-time token required to confirm the account.
"""
token: String!
): ConfirmAccount
"""
Sets the user's password from the token sent by email using the RequestPasswordReset mutation.
"""
setPassword(
"""
Email of a user.
"""
email: String!
"""
Password of a user.
"""
password: String!
"""
A one-time token required to set the password.
"""
token: String!
): SetPassword
"""
Change the password of the logged in user.
"""
passwordChange(
"""
New user password.
"""
newPassword: String!
"""
Current user password.
"""
oldPassword: String!
): PasswordChange
"""
Request email change of the logged in user.
"""
requestEmailChange(
"""
New user email.
"""
newEmail: String!
"""
User password.
"""
password: String!
"""
URL of a view where users should be redirected to update the email address. URL in RFC 1808 format.
"""
redirectUrl: String!
): RequestEmailChange
"""
Confirm the email change of the logged-in user.
"""
confirmEmailChange(
"""
A one-time token required to change the email.
"""
token: String!
): ConfirmEmailChange
"""
Create a new address for the customer.
"""
accountAddressCreate(
"""
Fields required to create address.
"""
input: AddressInput!
"""
A type of address. If provided, the new address will be automatically assigned as the customer's default address of that type.
"""
type: AddressTypeEnum
): AccountAddressCreate
"""
Updates an address of the logged-in user.
"""
accountAddressUpdate(
"""
ID of the address to update.
"""
id: ID!
"""
Fields required to update the address.
"""
input: AddressInput!
): AccountAddressUpdate
"""
Delete an address of the logged-in user.
"""
accountAddressDelete(
"""
ID of the address to delete.
"""
id: ID!
): AccountAddressDelete
"""
Sets a default address for the authenticated user.
"""
accountSetDefaultAddress(
"""
ID of the address to set as default.
"""
id: ID!
"""
The type of address.
"""
type: AddressTypeEnum!
): AccountSetDefaultAddress
"""
Register a new user.
"""
accountRegister(
"""
Fields required to create a user.
"""
input: AccountRegisterInput!
): AccountRegister
"""
Updates the account of the logged-in user.
"""
accountUpdate(
"""
Fields required to update the account of the logged-in user.
"""
input: AccountInput!
): AccountUpdate
"""
Sends an email with the account removal link for the logged-in user.
"""
accountRequestDeletion(
"""
URL of a view where users should be redirected to delete their account. URL in RFC 1808 format.
"""
redirectUrl: String!
): AccountRequestDeletion
"""
Remove user account.
"""
accountDelete(
"""
A one-time token required to remove account. Sent by email using AccountRequestDeletion mutation.
"""
token: String!
): AccountDelete
"""
Creates user address.
"""
addressCreate(
"""
Fields required to create address.
"""
input: AddressInput!
"""
ID of a user to create address for.
"""
userId: ID!
): AddressCreate
"""
Updates an address.
"""
addressUpdate(
"""
ID of the address to update.
"""
id: ID!
"""
Fields required to update the address.
"""
input: AddressInput!
): AddressUpdate
"""
Deletes an address.
"""
addressDelete(
"""
ID of the address to delete.
"""
id: ID!
): AddressDelete
"""
Sets a default address for the given user.
"""
addressSetDefault(
"""
ID of the address.
"""
addressId: ID!
"""
The type of address.
"""
type: AddressTypeEnum!
"""
ID of the user to change the address for.
"""
userId: ID!
): AddressSetDefault
"""
Creates a new customer.
"""
customerCreate(
"""
Fields required to create a customer.
"""
input: UserCreateInput!
): CustomerCreate
"""
Updates an existing customer.
"""
customerUpdate(
"""
ID of a customer to update.
"""
id: ID!
"""
Fields required to update a customer.
"""
input: CustomerInput!
): CustomerUpdate
"""
Deletes a customer.
"""
customerDelete(
"""
ID of a customer to delete.
"""
id: ID!
): CustomerDelete
"""
Deletes customers.
"""
customerBulkDelete(
"""
List of user IDs to delete.
"""
ids: [ID]!
): CustomerBulkDelete
"""
Creates a new staff user.
"""
staffCreate(
"""
Fields required to create a staff user.
"""
input: StaffCreateInput!
): StaffCreate
"""
Updates an existing staff user.
"""
staffUpdate(
"""
ID of a staff user to update.
"""
id: ID!
"""
Fields required to update a staff user.
"""
input: StaffUpdateInput!
): StaffUpdate
"""
Deletes a staff user.
"""
staffDelete(
"""
ID of a staff user to delete.
"""
id: ID!
): StaffDelete
"""
Deletes staff users.
"""
staffBulkDelete(
"""
List of user IDs to delete.
"""
ids: [ID]!
): StaffBulkDelete
"""
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
"""
userAvatarUpdate(
"""
Represents an image file in a multipart request.
"""
image: Upload!
): UserAvatarUpdate
"""
Deletes a user avatar. Only for staff members.
"""
userAvatarDelete: UserAvatarDelete
"""
Activate or deactivate users.
"""
userBulkSetActive(
"""
List of user IDs to (de)activate).
"""
ids: [ID]!
"""
Determine if users will be set active or not.
"""
isActive: Boolean!
): UserBulkSetActive
"""
Create new permission group.
"""
permissionGroupCreate(
"""
Input fields to create permission group.
"""
input: PermissionGroupCreateInput!
): PermissionGroupCreate
"""
Update permission group.
"""
permissionGroupUpdate(
"""
ID of the group to update.
"""
id: ID!
"""
Input fields to create permission group.
"""
input: PermissionGroupUpdateInput!
): PermissionGroupUpdate
"""
Delete permission group.
"""
permissionGroupDelete(
"""
ID of the group to delete.
"""
id: ID!
): PermissionGroupDelete
}
"""
Creates a new webhook subscription.
"""
type WebhookCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
webhookErrors: [WebhookError!]!
webhook: Webhook
}
"""
Represents an error in the input of a mutation.
"""
type Error {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
}
type WebhookError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: WebhookErrorCode!
}
"""
An enumeration.
"""
enum WebhookErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input WebhookCreateInput {
"""
The name of the webhook.
"""
name: String
"""
The url to receive the payload.
"""
targetUrl: String
"""
The events that webhook wants to subscribe.
"""
events: [WebhookEventTypeEnum]
"""
ID of the app to which webhook belongs.
"""
app: ID
"""
Determine if webhook will be set active or not.
"""
isActive: Boolean
"""
The secret key used to create a hash signature with each payload.
"""
secretKey: String
}
"""
Deletes a webhook subscription.
"""
type WebhookDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
webhookErrors: [WebhookError!]!
webhook: Webhook
}
"""
Updates a webhook subscription.
"""
type WebhookUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
webhookErrors: [WebhookError!]!
webhook: Webhook
}
input WebhookUpdateInput {
"""
The new name of the webhook.
"""
name: String
"""
The url to receive the payload.
"""
targetUrl: String
"""
The events that webhook wants to subscribe.
"""
events: [WebhookEventTypeEnum]
"""
ID of the app to which webhook belongs.
"""
app: ID
"""
Determine if webhook will be set active or not.
"""
isActive: Boolean
"""
Use to create a hash signature with each payload.
"""
secretKey: String
}
"""
Creates new warehouse.
"""
type WarehouseCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
warehouseErrors: [WarehouseError!]!
warehouse: Warehouse
}
type WarehouseError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: WarehouseErrorCode!
}
"""
An enumeration.
"""
enum WarehouseErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input WarehouseCreateInput {
"""
Warehouse slug.
"""
slug: String
"""
Company name.
"""
companyName: String
"""
The email address of the warehouse.
"""
email: String
"""
Warehouse name.
"""
name: String!
"""
Address of the warehouse.
"""
address: WarehouseAddressInput!
"""
Shipping zones supported by the warehouse.
"""
shippingZones: [ID]
}
input WarehouseAddressInput {
"""
Address.
"""
streetAddress1: String!
"""
Address.
"""
streetAddress2: String
"""
City.
"""
city: String!
"""
District.
"""
cityArea: String
"""
Postal code.
"""
postalCode: String
"""
Country.
"""
country: CountryCode!
"""
State or province.
"""
countryArea: String
"""
Phone number.
"""
phone: String
}
"""
Updates given warehouse.
"""
type WarehouseUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
warehouseErrors: [WarehouseError!]!
warehouse: Warehouse
}
input WarehouseUpdateInput {
"""
Warehouse slug.
"""
slug: String
"""
Company name.
"""
companyName: String
"""
The email address of the warehouse.
"""
email: String
"""
Warehouse name.
"""
name: String
"""
Address of the warehouse.
"""
address: WarehouseAddressInput
}
"""
Deletes selected warehouse.
"""
type WarehouseDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
warehouseErrors: [WarehouseError!]!
warehouse: Warehouse
}
"""
Add shipping zone to given warehouse.
"""
type WarehouseShippingZoneAssign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
warehouseErrors: [WarehouseError!]!
warehouse: Warehouse
}
"""
Remove shipping zone from given warehouse.
"""
type WarehouseShippingZoneUnassign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
warehouseErrors: [WarehouseError!]!
warehouse: Warehouse
}
"""
Creates a new staff notification recipient.
"""
type StaffNotificationRecipientCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
shopErrors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
}
type ShopError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ShopErrorCode!
}
"""
An enumeration.
"""
enum ShopErrorCode {
ALREADY_EXISTS
CANNOT_FETCH_TAX_RATES
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input StaffNotificationRecipientInput {
"""
The ID of the user subscribed to email notifications..
"""
user: ID
"""
Email address of a user subscribed to email notifications.
"""
email: String
"""
Determines if a notification active.
"""
active: Boolean
}
"""
Updates a staff notification recipient.
"""
type StaffNotificationRecipientUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
shopErrors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
}
"""
Delete staff notification recipient.
"""
type StaffNotificationRecipientDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
shopErrors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
}
"""
Updates site domain of the shop.
"""
type ShopDomainUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated shop.
"""
shop: Shop
shopErrors: [ShopError!]!
}
input SiteDomainInput {
"""
Domain name for shop.
"""
domain: String
"""
Shop site name.
"""
name: String
}
"""
Updates shop settings.
"""
type ShopSettingsUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated shop.
"""
shop: Shop
shopErrors: [ShopError!]!
}
input ShopSettingsInput {
"""
Header text.
"""
headerText: String
"""
SEO description.
"""
description: String
"""
Include taxes in prices.
"""
includeTaxesInPrices: Boolean
"""
Display prices with tax in store.
"""
displayGrossPrices: Boolean
"""
Charge taxes on shipping.
"""
chargeTaxesOnShipping: Boolean
"""
Enable inventory tracking.
"""
trackInventoryByDefault: Boolean
"""
Default weight unit.
"""
defaultWeightUnit: WeightUnitsEnum
"""
Enable automatic fulfillment for all digital products.
"""
automaticFulfillmentDigitalProducts: Boolean
"""
Default number of max downloads per digital content URL.
"""
defaultDigitalMaxDownloads: Int
"""
Default number of days which digital content URL will be valid.
"""
defaultDigitalUrlValidDays: Int
"""
Default email sender's name.
"""
defaultMailSenderName: String
"""
Default email sender's address.
"""
defaultMailSenderAddress: String
"""
URL of a view where customers can set their password.
"""
customerSetPasswordUrl: String
}
"""
Fetch tax rates.
"""
type ShopFetchTaxRates {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated shop.
"""
shop: Shop
shopErrors: [ShopError!]!
}
"""
Creates/Updates translations for Shop Settings.
"""
type ShopSettingsTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated shop.
"""
shop: Shop
translationErrors: [TranslationError!]!
}
type TranslationError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: TranslationErrorCode!
}
"""
An enumeration.
"""
enum TranslationErrorCode {
GRAPHQL_ERROR
NOT_FOUND
REQUIRED
}
input ShopSettingsTranslationInput {
headerText: String
description: String
}
"""
Update the shop's address. If the `null` value is passed, the currently selected address will be deleted.
"""
type ShopAddressUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated shop.
"""
shop: Shop
shopErrors: [ShopError!]!
}
"""
Update shop order settings.
"""
type OrderSettingsUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order settings.
"""
orderSettings: OrderSettings
orderSettingsErrors: [OrderSettingsError!]!
}
type OrderSettingsError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: OrderSettingsErrorCode!
}
"""
An enumeration.
"""
enum OrderSettingsErrorCode {
INVALID
}
input OrderSettingsUpdateInput {
"""
When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately.
"""
automaticallyConfirmAllNewOrders: Boolean!
}
"""
Manage shipping method's availability in channels.
"""
type ShippingMethodChannelListingUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated shipping method instance.
"""
shippingMethod: ShippingMethod
shippingErrors: [ShippingError!]!
}
type ShippingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ShippingErrorCode!
"""
List of warehouse IDs which causes the error.
"""
warehouses: [ID!]
"""
List of channels IDs which causes the error.
"""
channels: [ID!]
}
"""
An enumeration.
"""
enum ShippingErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
MAX_LESS_THAN_MIN
NOT_FOUND
REQUIRED
UNIQUE
DUPLICATED_INPUT_ITEM
}
input ShippingMethodChannelListingInput {
"""
List of channels to which the shipping method should be assigned.
"""
addChannels: [ShippingMethodChannelListingAddInput!]
"""
List of channels from which the shipping method should be unassigned.
"""
removeChannels: [ID!]
}
input ShippingMethodChannelListingAddInput {
"""
ID of a channel.
"""
channelId: ID!
"""
Shipping price of the shipping method in this channel.
"""
price: PositiveDecimal
"""
Minimum order price to use this shipping method.
"""
minimumOrderPrice: PositiveDecimal
"""
Maximum order price to use this shipping method.
"""
maximumOrderPrice: PositiveDecimal
}
"""
Creates a new shipping price.
"""
type ShippingPriceCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A shipping zone to which the shipping method belongs.
"""
shippingZone: ShippingZone
shippingMethod: ShippingMethod
shippingErrors: [ShippingError!]!
}
input ShippingPriceInput {
"""
Name of the shipping method.
"""
name: String
"""
Shipping method description (JSON).
"""
description: JSONString
"""
Minimum order weight to use this shipping method.
"""
minimumOrderWeight: WeightScalar
"""
Maximum order weight to use this shipping method.
"""
maximumOrderWeight: WeightScalar
"""
Maximum number of days for delivery.
"""
maximumDeliveryDays: Int
"""
Minimal number of days for delivery.
"""
minimumDeliveryDays: Int
"""
Shipping type: price or weight based.
"""
type: ShippingMethodTypeEnum
"""
Shipping zone this method belongs to.
"""
shippingZone: ID
"""
Postal code rules to add.
"""
addPostalCodeRules: [ShippingPostalCodeRulesCreateInputRange!]
"""
Postal code rules to delete.
"""
deletePostalCodeRules: [ID!]
"""
Inclusion type for currently assigned postal code rules.
"""
inclusionType: PostalCodeRuleInclusionTypeEnum
}
scalar WeightScalar
input ShippingPostalCodeRulesCreateInputRange {
"""
Start range of the postal code.
"""
start: String!
"""
End range of the postal code.
"""
end: String
}
"""
Deletes a shipping price.
"""
type ShippingPriceDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A shipping method to delete.
"""
shippingMethod: ShippingMethod
"""
A shipping zone to which the shipping method belongs.
"""
shippingZone: ShippingZone
shippingErrors: [ShippingError!]!
}
"""
Deletes shipping prices.
"""
type ShippingPriceBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
shippingErrors: [ShippingError!]!
}
"""
Updates a new shipping price.
"""
type ShippingPriceUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A shipping zone to which the shipping method belongs.
"""
shippingZone: ShippingZone
shippingMethod: ShippingMethod
shippingErrors: [ShippingError!]!
}
"""
Creates/Updates translations for shipping method.
"""
type ShippingPriceTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
shippingMethod: ShippingMethod
}
input ShippingPriceTranslationInput {
name: String
"""
Translated shipping method description (JSON).
"""
description: JSONString
}
"""
Exclude products from shipping price.
"""
type ShippingPriceExcludeProducts {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A shipping method with new list of excluded products.
"""
shippingMethod: ShippingMethod
shippingErrors: [ShippingError!]!
}
input ShippingPriceExcludeProductsInput {
"""
List of products which will be excluded.
"""
products: [ID]!
}
"""
Remove product from excluded list for shipping price.
"""
type ShippingPriceRemoveProductFromExclude {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A shipping method with new list of excluded products.
"""
shippingMethod: ShippingMethod
shippingErrors: [ShippingError!]!
}
"""
Creates a new shipping zone.
"""
type ShippingZoneCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
shippingErrors: [ShippingError!]!
shippingZone: ShippingZone
}
input ShippingZoneCreateInput {
"""
Shipping zone's name. Visible only to the staff.
"""
name: String
"""
Description of the shipping zone.
"""
description: String
"""
List of countries in this shipping zone.
"""
countries: [String]
"""
Default shipping zone will be used for countries not covered by other zones.
"""
default: Boolean
"""
List of warehouses to assign to a shipping zone
"""
addWarehouses: [ID]
"""
List of channels to assign to the shipping zone.
"""
addChannels: [ID!]
}
"""
Deletes a shipping zone.
"""
type ShippingZoneDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
shippingErrors: [ShippingError!]!
shippingZone: ShippingZone
}
"""
Deletes shipping zones.
"""
type ShippingZoneBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
shippingErrors: [ShippingError!]!
}
"""
Updates a new shipping zone.
"""
type ShippingZoneUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
shippingErrors: [ShippingError!]!
shippingZone: ShippingZone
}
input ShippingZoneUpdateInput {
"""
Shipping zone's name. Visible only to the staff.
"""
name: String
"""
Description of the shipping zone.
"""
description: String
"""
List of countries in this shipping zone.
"""
countries: [String]
"""
Default shipping zone will be used for countries not covered by other zones.
"""
default: Boolean
"""
List of warehouses to assign to a shipping zone
"""
addWarehouses: [ID]
"""
List of channels to assign to the shipping zone.
"""
addChannels: [ID!]
"""
List of warehouses to unassign from a shipping zone
"""
removeWarehouses: [ID]
"""
List of channels to unassign from the shipping zone.
"""
removeChannels: [ID!]
}
"""
Assign attributes to a given product type.
"""
type ProductAttributeAssign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The updated product type.
"""
productType: ProductType
productErrors: [ProductError!]!
}
type ProductError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ProductErrorCode!
"""
List of attributes IDs which causes the error.
"""
attributes: [ID!]
"""
List of attribute values IDs which causes the error.
"""
values: [ID!]
}
"""
An enumeration.
"""
enum ProductErrorCode {
ALREADY_EXISTS
ATTRIBUTE_ALREADY_ASSIGNED
ATTRIBUTE_CANNOT_BE_ASSIGNED
ATTRIBUTE_VARIANTS_DISABLED
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
PRODUCT_WITHOUT_CATEGORY
NOT_PRODUCTS_IMAGE
NOT_PRODUCTS_VARIANT
NOT_FOUND
REQUIRED
UNIQUE
VARIANT_NO_DIGITAL_CONTENT
CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT
PRODUCT_NOT_ASSIGNED_TO_CHANNEL
UNSUPPORTED_MEDIA_PROVIDER
}
input ProductAttributeAssignInput {
"""
The ID of the attribute to assign.
"""
id: ID!
"""
The attribute type to be assigned as.
"""
type: ProductAttributeType!
}
enum ProductAttributeType {
PRODUCT
VARIANT
}
"""
Un-assign attributes from a given product type.
"""
type ProductAttributeUnassign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The updated product type.
"""
productType: ProductType
productErrors: [ProductError!]!
}
"""
Creates a new category.
"""
type CategoryCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
category: Category
}
input CategoryInput {
"""
Category description (JSON).
"""
description: JSONString
"""
Category name.
"""
name: String
"""
Category slug.
"""
slug: String
"""
Search engine optimization fields.
"""
seo: SeoInput
"""
Background image file.
"""
backgroundImage: Upload
"""
Alt text for a product media.
"""
backgroundImageAlt: String
}
input SeoInput {
"""
SEO title.
"""
title: String
"""
SEO description.
"""
description: String
}
"""
Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec.
"""
scalar Upload
"""
Deletes a category.
"""
type CategoryDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
category: Category
}
"""
Deletes categories.
"""
type CategoryBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
productErrors: [ProductError!]!
}
"""
Updates a category.
"""
type CategoryUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
category: Category
}
"""
Creates/Updates translations for Category.
"""
type CategoryTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
category: Category
}
input TranslationInput {
seoTitle: String
seoDescription: String
name: String
description: JSONString
}
"""
Adds products to a collection.
"""
type CollectionAddProducts {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Collection to which products will be added.
"""
collection: Collection
collectionErrors: [CollectionError!]!
}
type CollectionError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
List of products IDs which causes the error.
"""
products: [ID!]
"""
The error code.
"""
code: CollectionErrorCode!
}
"""
An enumeration.
"""
enum CollectionErrorCode {
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT
}
"""
Creates a new collection.
"""
type CollectionCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
collectionErrors: [CollectionError!]!
collection: Collection
}
input CollectionCreateInput {
"""
Informs whether a collection is published.
"""
isPublished: Boolean
"""
Name of the collection.
"""
name: String
"""
Slug of the collection.
"""
slug: String
"""
Description of the collection (JSON).
"""
description: JSONString
"""
Background image file.
"""
backgroundImage: Upload
"""
Alt text for an image.
"""
backgroundImageAlt: String
"""
Search engine optimization fields.
"""
seo: SeoInput
"""
Publication date. ISO 8601 standard.
"""
publicationDate: Date
"""
List of products to be added to the collection.
"""
products: [ID]
}
"""
Deletes a collection.
"""
type CollectionDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
collectionErrors: [CollectionError!]!
collection: Collection
}
"""
Reorder the products of a collection.
"""
type CollectionReorderProducts {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Collection from which products are reordered.
"""
collection: Collection
collectionErrors: [CollectionError!]!
}
input MoveProductInput {
"""
The ID of the product to move.
"""
productId: ID!
"""
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.
"""
sortOrder: Int
}
"""
Deletes collections.
"""
type CollectionBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
collectionErrors: [CollectionError!]!
}
"""
Remove products from a collection.
"""
type CollectionRemoveProducts {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Collection from which products will be removed.
"""
collection: Collection
collectionErrors: [CollectionError!]!
}
"""
Updates a collection.
"""
type CollectionUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
collectionErrors: [CollectionError!]!
collection: Collection
}
input CollectionInput {
"""
Informs whether a collection is published.
"""
isPublished: Boolean
"""
Name of the collection.
"""
name: String
"""
Slug of the collection.
"""
slug: String
"""
Description of the collection (JSON).
"""
description: JSONString
"""
Background image file.
"""
backgroundImage: Upload
"""
Alt text for an image.
"""
backgroundImageAlt: String
"""
Search engine optimization fields.
"""
seo: SeoInput
"""
Publication date. ISO 8601 standard.
"""
publicationDate: Date
}
"""
Creates/Updates translations for collection.
"""
type CollectionTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
collection: Collection
}
"""
Manage collection's availability in channels.
"""
type CollectionChannelListingUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated collection instance.
"""
collection: Collection
collectionChannelListingErrors: [CollectionChannelListingError!]!
}
type CollectionChannelListingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ProductErrorCode!
"""
List of attributes IDs which causes the error.
"""
attributes: [ID!]
"""
List of attribute values IDs which causes the error.
"""
values: [ID!]
"""
List of channels IDs which causes the error.
"""
channels: [ID!]
}
input CollectionChannelListingUpdateInput {
"""
List of channels to which the collection should be assigned.
"""
addChannels: [PublishableChannelListingInput!]
"""
List of channels from which the collection should be unassigned.
"""
removeChannels: [ID!]
}
input PublishableChannelListingInput {
"""
ID of a channel.
"""
channelId: ID!
"""
Determines if object is visible to customers.
"""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
"""
publicationDate: Date
}
"""
Creates a new product.
"""
type ProductCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
product: Product
}
input ProductCreateInput {
"""
List of attributes.
"""
attributes: [AttributeValueInput!]
"""
ID of the product's category.
"""
category: ID
"""
Determine if taxes are being charged for the product.
"""
chargeTaxes: Boolean
"""
List of IDs of collections that the product belongs to.
"""
collections: [ID!]
"""
Product description (JSON).
"""
description: JSONString
"""
Product name.
"""
name: String
"""
Product slug.
"""
slug: String
"""
Tax rate for enabled tax gateway.
"""
taxCode: String
"""
Search engine optimization fields.
"""
seo: SeoInput
"""
Weight of the Product.
"""
weight: WeightScalar
"""
Defines the product rating value.
"""
rating: Float
"""
ID of the type that product belongs to.
"""
productType: ID!
}
input AttributeValueInput {
"""
ID of the selected attribute.
"""
id: ID
"""
The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
"""
values: [String]
"""
URL of the file attribute. Every time, a new value is created.
"""
file: String
"""
File content type.
"""
contentType: String
"""
List of entity IDs that will be used as references.
"""
references: [ID!]
"""
Text content in JSON format.
"""
richText: JSONString
}
"""
Deletes a product.
"""
type ProductDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
product: Product
}
"""
Deletes products.
"""
type ProductBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
productErrors: [ProductError!]!
}
"""
Updates an existing product.
"""
type ProductUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
product: Product
}
input ProductInput {
"""
List of attributes.
"""
attributes: [AttributeValueInput!]
"""
ID of the product's category.
"""
category: ID
"""
Determine if taxes are being charged for the product.
"""
chargeTaxes: Boolean
"""
List of IDs of collections that the product belongs to.
"""
collections: [ID!]
"""
Product description (JSON).
"""
description: JSONString
"""
Product name.
"""
name: String
"""
Product slug.
"""
slug: String
"""
Tax rate for enabled tax gateway.
"""
taxCode: String
"""
Search engine optimization fields.
"""
seo: SeoInput
"""
Weight of the Product.
"""
weight: WeightScalar
"""
Defines the product rating value.
"""
rating: Float
}
"""
Creates/Updates translations for Product.
"""
type ProductTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
product: Product
}
"""
Manage product's availability in channels.
"""
type ProductChannelListingUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated product instance.
"""
product: Product
productChannelListingErrors: [ProductChannelListingError!]!
}
type ProductChannelListingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ProductErrorCode!
"""
List of attributes IDs which causes the error.
"""
attributes: [ID!]
"""
List of attribute values IDs which causes the error.
"""
values: [ID!]
"""
List of channels IDs which causes the error.
"""
channels: [ID!]
"""
List of variants IDs which causes the error.
"""
variants: [ID!]
}
input ProductChannelListingUpdateInput {
"""
List of channels to which the product should be assigned or updated.
"""
updateChannels: [ProductChannelListingAddInput!]
"""
List of channels from which the product should be unassigned.
"""
removeChannels: [ID!]
}
input ProductChannelListingAddInput {
"""
ID of a channel.
"""
channelId: ID!
"""
Determines if object is visible to customers.
"""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
"""
publicationDate: Date
"""
Determines if product is visible in product listings (doesn't apply to product collections).
"""
visibleInListings: Boolean
"""
Determine if product should be available for purchase.
"""
isAvailableForPurchase: Boolean
"""
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.
"""
availableForPurchaseDate: Date
"""
List of variants to which the channel should be assigned.
"""
addVariants: [ID!]
"""
List of variants from which the channel should be unassigned.
"""
removeVariants: [ID!]
}
"""
Create a media object (image or video URL) associated with product. For 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
"""
type ProductMediaCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
product: Product
media: ProductMedia
productErrors: [ProductError!]!
}
input ProductMediaCreateInput {
"""
Alt text for a product media.
"""
alt: String
"""
Represents an image file in a multipart request.
"""
image: Upload
"""
ID of an product.
"""
product: ID!
"""
Represents an URL to an external media.
"""
mediaUrl: String
}
"""
Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.
"""
type ProductVariantReorder {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
product: Product
productErrors: [ProductError!]!
}
input ReorderInput {
"""
The ID of the item to move.
"""
id: ID!
"""
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.
"""
sortOrder: Int
}
"""
Deletes a product media.
"""
type ProductMediaDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
product: Product
media: ProductMedia
productErrors: [ProductError!]!
}
"""
Deletes product media.
"""
type ProductMediaBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
productErrors: [ProductError!]!
}
"""
Changes ordering of the product media.
"""
type ProductMediaReorder {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
product: Product
media: [ProductMedia!]
productErrors: [ProductError!]!
}
"""
Updates a product media.
"""
type ProductMediaUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
product: Product
media: ProductMedia
productErrors: [ProductError!]!
}
input ProductMediaUpdateInput {
"""
Alt text for a product media.
"""
alt: String
}
"""
Creates a new product type.
"""
type ProductTypeCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
productType: ProductType
}
input ProductTypeInput {
"""
Name of the product type.
"""
name: String
"""
Product type slug.
"""
slug: String
"""
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.
"""
hasVariants: Boolean
"""
List of attributes shared among all product variants.
"""
productAttributes: [ID]
"""
List of attributes used to distinguish between different variants of a product.
"""
variantAttributes: [ID]
"""
Determines if shipping is required for products of this variant.
"""
isShippingRequired: Boolean
"""
Determines if products are digital.
"""
isDigital: Boolean
"""
Weight of the ProductType items.
"""
weight: WeightScalar
"""
Tax rate for enabled tax gateway.
"""
taxCode: String
}
"""
Deletes a product type.
"""
type ProductTypeDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
productType: ProductType
}
"""
Deletes product types.
"""
type ProductTypeBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
productErrors: [ProductError!]!
}
"""
Updates an existing product type.
"""
type ProductTypeUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
productType: ProductType
}
"""
Reorder the attributes of a product type.
"""
type ProductTypeReorderAttributes {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Product type from which attributes are reordered.
"""
productType: ProductType
productErrors: [ProductError!]!
}
"""
Reorder product attribute values.
"""
type ProductReorderAttributeValues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Product from which attribute values are reordered.
"""
product: Product
productErrors: [ProductError!]!
}
"""
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
"""
type DigitalContentCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
variant: ProductVariant
content: DigitalContent
productErrors: [ProductError!]!
}
input DigitalContentUploadInput {
"""
Use default digital content settings for this product.
"""
useDefaultSettings: Boolean!
"""
Determines how many times a download link can be accessed by a customer.
"""
maxDownloads: Int
"""
Determines for how many days a download link is active since it was generated.
"""
urlValidDays: Int
"""
Overwrite default automatic_fulfillment setting for variant.
"""
automaticFulfillment: Boolean
"""
Represents an file in a multipart request.
"""
contentFile: Upload!
}
"""
Remove digital content assigned to given variant.
"""
type DigitalContentDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
variant: ProductVariant
productErrors: [ProductError!]!
}
"""
Update digital content.
"""
type DigitalContentUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
variant: ProductVariant
content: DigitalContent
productErrors: [ProductError!]!
}
input DigitalContentInput {
"""
Use default digital content settings for this product.
"""
useDefaultSettings: Boolean!
"""
Determines how many times a download link can be accessed by a customer.
"""
maxDownloads: Int
"""
Determines for how many days a download link is active since it was generated.
"""
urlValidDays: Int
"""
Overwrite default automatic_fulfillment setting for variant.
"""
automaticFulfillment: Boolean
}
"""
Generate new URL to digital content.
"""
type DigitalContentUrlCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
digitalContentUrl: DigitalContentUrl
}
input DigitalContentUrlCreateInput {
"""
Digital content ID which URL will belong to.
"""
content: ID!
}
"""
Creates a new variant for a product.
"""
type ProductVariantCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
productVariant: ProductVariant
}
input ProductVariantCreateInput {
"""
List of attributes specific to this variant.
"""
attributes: [AttributeValueInput]!
"""
Stock keeping unit.
"""
sku: String
"""
Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.
"""
trackInventory: Boolean
"""
Weight of the Product Variant.
"""
weight: WeightScalar
"""
Product ID of which type is the variant.
"""
product: ID!
"""
Stocks of a product available for sale.
"""
stocks: [StockInput!]
}
input StockInput {
"""
Warehouse in which stock is located.
"""
warehouse: ID!
"""
Quantity of items available for sell.
"""
quantity: Int!
}
"""
Deletes a product variant.
"""
type ProductVariantDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
productVariant: ProductVariant
}
"""
Creates product variants for a given product.
"""
type ProductVariantBulkCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were created.
"""
count: Int!
"""
List of the created variants.
"""
productVariants: [ProductVariant!]!
bulkProductErrors: [BulkProductError!]!
}
type BulkProductError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ProductErrorCode!
"""
List of attributes IDs which causes the error.
"""
attributes: [ID!]
"""
List of attribute values IDs which causes the error.
"""
values: [ID!]
"""
Index of an input list item that caused the error.
"""
index: Int
"""
List of warehouse IDs which causes the error.
"""
warehouses: [ID!]
"""
List of channel IDs which causes the error.
"""
channels: [ID!]
}
input ProductVariantBulkCreateInput {
"""
List of attributes specific to this variant.
"""
attributes: [BulkAttributeValueInput]!
"""
Stock keeping unit.
"""
sku: String!
"""
Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.
"""
trackInventory: Boolean
"""
Weight of the Product Variant.
"""
weight: WeightScalar
"""
Stocks of a product available for sale.
"""
stocks: [StockInput!]
"""
List of prices assigned to channels.
"""
channelListings: [ProductVariantChannelListingAddInput!]
}
input BulkAttributeValueInput {
"""
ID of the selected attribute.
"""
id: ID
"""
The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
"""
values: [String]!
}
input ProductVariantChannelListingAddInput {
"""
ID of a channel.
"""
channelId: ID!
"""
Price of the particular variant in channel.
"""
price: PositiveDecimal!
"""
Cost price of the variant in channel.
"""
costPrice: PositiveDecimal
}
"""
Deletes product variants.
"""
type ProductVariantBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
productErrors: [ProductError!]!
}
"""
Creates stocks for product variant.
"""
type ProductVariantStocksCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated product variant.
"""
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]!
}
type BulkStockError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ProductErrorCode!
"""
List of attributes IDs which causes the error.
"""
attributes: [ID!]
"""
List of attribute values IDs which causes the error.
"""
values: [ID!]
"""
Index of an input list item that caused the error.
"""
index: Int
}
"""
Delete stocks from product variant.
"""
type ProductVariantStocksDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated product variant.
"""
productVariant: ProductVariant
stockErrors: [StockError!]!
}
type StockError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: StockErrorCode!
}
"""
An enumeration.
"""
enum StockErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
"""
Update stocks for product variant.
"""
type ProductVariantStocksUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated product variant.
"""
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]!
}
"""
Updates an existing variant for product.
"""
type ProductVariantUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productErrors: [ProductError!]!
productVariant: ProductVariant
}
input ProductVariantInput {
"""
List of attributes specific to this variant.
"""
attributes: [AttributeValueInput]
"""
Stock keeping unit.
"""
sku: String
"""
Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.
"""
trackInventory: Boolean
"""
Weight of the Product Variant.
"""
weight: WeightScalar
}
"""
Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
"""
type ProductVariantSetDefault {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
product: Product
productErrors: [ProductError!]!
}
"""
Creates/Updates translations for Product Variant.
"""
type ProductVariantTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
productVariant: ProductVariant
}
input NameTranslationInput {
name: String
}
"""
Manage product variant prices in channels.
"""
type ProductVariantChannelListingUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated product variant instance.
"""
variant: ProductVariant
productChannelListingErrors: [ProductChannelListingError!]!
}
"""
Reorder product variant attribute values.
"""
type ProductVariantReorderAttributeValues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Product variant from which attribute values are reordered.
"""
productVariant: ProductVariant
productErrors: [ProductError!]!
}
"""
Assign an media to a product variant.
"""
type VariantMediaAssign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productVariant: ProductVariant
media: ProductMedia
productErrors: [ProductError!]!
}
"""
Unassign an media from a product variant.
"""
type VariantMediaUnassign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
productVariant: ProductVariant
media: ProductMedia
productErrors: [ProductError!]!
}
"""
Captures the authorized payment amount.
"""
type PaymentCapture {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated payment.
"""
payment: Payment
paymentErrors: [PaymentError!]!
}
type PaymentError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: PaymentErrorCode!
}
"""
An enumeration.
"""
enum PaymentErrorCode {
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
}
"""
Refunds the captured payment amount.
"""
type PaymentRefund {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated payment.
"""
payment: Payment
paymentErrors: [PaymentError!]!
}
"""
Voids the authorized payment.
"""
type PaymentVoid {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Updated payment.
"""
payment: Payment
paymentErrors: [PaymentError!]!
}
"""
Initializes payment process when it is required by gateway.
"""
type PaymentInitialize {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
initializedPayment: PaymentInitialized
paymentErrors: [PaymentError!]!
}
"""
Server-side data generated by a payment gateway. Optional step when the payment provider requires an additional action to initialize payment session.
"""
type PaymentInitialized {
"""
ID of a payment gateway.
"""
gateway: String!
"""
Payment gateway name.
"""
name: String!
"""
Initialized data by gateway.
"""
data: JSONString
}
"""
Creates a new page.
"""
type PageCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
pageErrors: [PageError!]!
page: Page
}
type PageError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: PageErrorCode!
"""
List of attributes IDs which causes the error.
"""
attributes: [ID!]
"""
List of attribute values IDs which causes the error.
"""
values: [ID!]
}
"""
An enumeration.
"""
enum PageErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
DUPLICATED_INPUT_ITEM
ATTRIBUTE_ALREADY_ASSIGNED
}
input PageCreateInput {
"""
Page internal name.
"""
slug: String
"""
Page title.
"""
title: String
"""
Page content in JSON format.
"""
content: JSONString
"""
List of attributes.
"""
attributes: [AttributeValueInput!]
"""
Determines if page is visible in the storefront.
"""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
"""
publicationDate: String
"""
Search engine optimization fields.
"""
seo: SeoInput
"""
ID of the page type that page belongs to.
"""
pageType: ID!
}
"""
Deletes a page.
"""
type PageDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
pageErrors: [PageError!]!
page: Page
}
"""
Deletes pages.
"""
type PageBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
pageErrors: [PageError!]!
}
"""
Publish pages.
"""
type PageBulkPublish {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
pageErrors: [PageError!]!
}
"""
Updates an existing page.
"""
type PageUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
pageErrors: [PageError!]!
page: Page
}
input PageInput {
"""
Page internal name.
"""
slug: String
"""
Page title.
"""
title: String
"""
Page content in JSON format.
"""
content: JSONString
"""
List of attributes.
"""
attributes: [AttributeValueInput!]
"""
Determines if page is visible in the storefront.
"""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
"""
publicationDate: String
"""
Search engine optimization fields.
"""
seo: SeoInput
}
"""
Creates/Updates translations for Page.
"""
type PageTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
page: PageTranslatableContent
}
input PageTranslationInput {
seoTitle: String
seoDescription: String
title: String
content: JSONString
}
"""
Create a new page type.
"""
type PageTypeCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
pageErrors: [PageError!]!
pageType: PageType
}
input PageTypeCreateInput {
"""
Name of the page type.
"""
name: String
"""
Page type slug.
"""
slug: String
"""
List of attribute IDs to be assigned to the page type.
"""
addAttributes: [ID!]
}
"""
Update page type.
"""
type PageTypeUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
pageErrors: [PageError!]!
pageType: PageType
}
input PageTypeUpdateInput {
"""
Name of the page type.
"""
name: String
"""
Page type slug.
"""
slug: String
"""
List of attribute IDs to be assigned to the page type.
"""
addAttributes: [ID!]
"""
List of attribute IDs to be assigned to the page type.
"""
removeAttributes: [ID!]
}
"""
Delete a page type.
"""
type PageTypeDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
pageErrors: [PageError!]!
pageType: PageType
}
"""
Delete page types.
"""
type PageTypeBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
pageErrors: [PageError!]!
}
"""
Assign attributes to a given page type.
"""
type PageAttributeAssign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The updated page type.
"""
pageType: PageType
pageErrors: [PageError!]!
}
"""
Unassign attributes from a given page type.
"""
type PageAttributeUnassign {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The updated page type.
"""
pageType: PageType
pageErrors: [PageError!]!
}
"""
Reorder the attributes of a page type.
"""
type PageTypeReorderAttributes {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Page type from which attributes are reordered.
"""
pageType: PageType
pageErrors: [PageError!]!
}
"""
Reorder page attribute values.
"""
type PageReorderAttributeValues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Page from which attribute values are reordered.
"""
page: Page
pageErrors: [PageError!]!
}
"""
Completes creating an order.
"""
type DraftOrderComplete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Completed order.
"""
order: Order
orderErrors: [OrderError!]!
}
type OrderError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: OrderErrorCode!
"""
Warehouse ID which causes the error.
"""
warehouse: ID
"""
Order line ID which causes the error.
"""
orderLine: ID
"""
List of product variants that are associated with the error
"""
variants: [ID!]
}
"""
An enumeration.
"""
enum OrderErrorCode {
BILLING_ADDRESS_NOT_SET
CANNOT_CANCEL_FULFILLMENT
CANNOT_CANCEL_ORDER
CANNOT_DELETE
CANNOT_DISCOUNT
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
INVALID_QUANTITY
INSUFFICIENT_STOCK
DUPLICATED_INPUT_ITEM
NOT_AVAILABLE_IN_CHANNEL
CHANNEL_INACTIVE
}
"""
Creates a new draft order.
"""
type DraftOrderCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
orderErrors: [OrderError!]!
order: Order
}
input DraftOrderCreateInput {
"""
Billing address of the customer.
"""
billingAddress: AddressInput
user: ID
"""
Email address of the customer.
"""
userEmail: String
"""
Discount amount for the order.
"""
discount: PositiveDecimal
"""
Shipping address of the customer.
"""
shippingAddress: AddressInput
"""
ID of a selected shipping method.
"""
shippingMethod: ID
"""
ID of the voucher associated with the order.
"""
voucher: ID
"""
A note from a customer. Visible by customers in the order summary.
"""
customerNote: String
"""
ID of the channel associated with the order.
"""
channel: ID
"""
URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.
"""
redirectUrl: String
"""
Variant line input consisting of variant ID and quantity of products.
"""
lines: [OrderLineCreateInput]
}
input OrderLineCreateInput {
"""
Number of variant items ordered.
"""
quantity: Int!
"""
Product variant ID.
"""
variantId: ID!
}
"""
Deletes a draft order.
"""
type DraftOrderDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
orderErrors: [OrderError!]!
order: Order
}
"""
Deletes draft orders.
"""
type DraftOrderBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
orderErrors: [OrderError!]!
}
"""
Deletes order lines.
"""
type DraftOrderLinesBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
orderErrors: [OrderError!]!
}
"""
Updates a draft order.
"""
type DraftOrderUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
orderErrors: [OrderError!]!
order: Order
}
input DraftOrderInput {
"""
Billing address of the customer.
"""
billingAddress: AddressInput
user: ID
"""
Email address of the customer.
"""
userEmail: String
"""
Discount amount for the order.
"""
discount: PositiveDecimal
"""
Shipping address of the customer.
"""
shippingAddress: AddressInput
"""
ID of a selected shipping method.
"""
shippingMethod: ID
"""
ID of the voucher associated with the order.
"""
voucher: ID
"""
A note from a customer. Visible by customers in the order summary.
"""
customerNote: String
"""
ID of the channel associated with the order.
"""
channel: ID
"""
URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.
"""
redirectUrl: String
}
"""
Adds note to the order.
"""
type OrderAddNote {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order with the note added.
"""
order: Order
"""
Order note created.
"""
event: OrderEvent
orderErrors: [OrderError!]!
}
input OrderAddNoteInput {
"""
Note message.
"""
message: String!
}
"""
Cancel an order.
"""
type OrderCancel {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Canceled order.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Capture an order.
"""
type OrderCapture {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Captured order.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Confirms an unconfirmed order by changing status to unfulfilled.
"""
type OrderConfirm {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
order: Order
orderErrors: [OrderError!]!
}
"""
Creates new fulfillments for an order.
"""
type OrderFulfill {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
List of created fulfillments.
"""
fulfillments: [Fulfillment]
"""
Fulfilled order.
"""
order: Order
orderErrors: [OrderError!]!
}
input OrderFulfillInput {
"""
List of items informing how to fulfill the order.
"""
lines: [OrderFulfillLineInput!]!
"""
If true, send an email notification to the customer.
"""
notifyCustomer: Boolean
}
input OrderFulfillLineInput {
"""
The ID of the order line.
"""
orderLineId: ID
"""
List of stock items to create.
"""
stocks: [OrderFulfillStockInput!]!
}
input OrderFulfillStockInput {
"""
The number of line items to be fulfilled from given warehouse.
"""
quantity: Int!
"""
ID of the warehouse from which the item will be fulfilled.
"""
warehouse: ID!
}
"""
Cancels existing fulfillment and optionally restocks items.
"""
type FulfillmentCancel {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A canceled fulfillment.
"""
fulfillment: Fulfillment
"""
Order which fulfillment was cancelled.
"""
order: Order
orderErrors: [OrderError!]!
}
input FulfillmentCancelInput {
"""
ID of warehouse where items will be restock.
"""
warehouseId: ID!
}
"""
Updates a fulfillment for an order.
"""
type FulfillmentUpdateTracking {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A fulfillment with updated tracking.
"""
fulfillment: Fulfillment
"""
Order for which fulfillment was updated.
"""
order: Order
orderErrors: [OrderError!]!
}
input FulfillmentUpdateTrackingInput {
"""
Fulfillment tracking number.
"""
trackingNumber: String
"""
If true, send an email notification to the customer.
"""
notifyCustomer: Boolean
}
"""
Refund products.
"""
type FulfillmentRefundProducts {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A refunded fulfillment.
"""
fulfillment: Fulfillment
"""
Order which fulfillment was refunded.
"""
order: Order
orderErrors: [OrderError!]!
}
input OrderRefundProductsInput {
"""
List of unfulfilled lines to refund.
"""
orderLines: [OrderRefundLineInput!]
"""
List of fulfilled lines to refund.
"""
fulfillmentLines: [OrderRefundFulfillmentLineInput!]
"""
The total amount of refund when the value is provided manually.
"""
amountToRefund: PositiveDecimal
"""
If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored.
"""
includeShippingCosts: Boolean
}
input OrderRefundLineInput {
"""
The ID of the order line to refund.
"""
orderLineId: ID!
"""
The number of items to be refunded.
"""
quantity: Int!
}
input OrderRefundFulfillmentLineInput {
"""
The ID of the fulfillment line to refund.
"""
fulfillmentLineId: ID!
"""
The number of items to be refunded.
"""
quantity: Int!
}
"""
Return products.
"""
type FulfillmentReturnProducts {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A return fulfillment.
"""
returnFulfillment: Fulfillment
"""
A replace fulfillment.
"""
replaceFulfillment: Fulfillment
"""
Order which fulfillment was returned.
"""
order: Order
"""
A draft order which was created for products with replace flag.
"""
replaceOrder: Order
orderErrors: [OrderError!]!
}
input OrderReturnProductsInput {
"""
List of unfulfilled lines to return.
"""
orderLines: [OrderReturnLineInput!]
"""
List of fulfilled lines to return.
"""
fulfillmentLines: [OrderReturnFulfillmentLineInput!]
"""
The total amount of refund when the value is provided manually.
"""
amountToRefund: PositiveDecimal
"""
If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored.
"""
includeShippingCosts: Boolean
"""
If true, Saleor will call refund action for all lines.
"""
refund: Boolean
}
input OrderReturnLineInput {
"""
The ID of the order line to return.
"""
orderLineId: ID!
"""
The number of items to be returned.
"""
quantity: Int!
"""
Determines, if the line should be added to replace order.
"""
replace: Boolean
}
input OrderReturnFulfillmentLineInput {
"""
The ID of the fulfillment line to return.
"""
fulfillmentLineId: ID!
"""
The number of items to be returned.
"""
quantity: Int!
"""
Determines, if the line should be added to replace order.
"""
replace: Boolean
}
"""
Create order lines for an order.
"""
type OrderLinesCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Related order.
"""
order: Order
"""
List of added order lines.
"""
orderLines: [OrderLine!]
orderErrors: [OrderError!]!
}
"""
Deletes an order line from an order.
"""
type OrderLineDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A related order.
"""
order: Order
"""
An order line that was deleted.
"""
orderLine: OrderLine
orderErrors: [OrderError!]!
}
"""
Updates an order line of an order.
"""
type OrderLineUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Related order.
"""
order: Order
orderErrors: [OrderError!]!
orderLine: OrderLine
}
input OrderLineInput {
"""
Number of variant items ordered.
"""
quantity: Int!
}
"""
Adds discount to the order.
"""
type OrderDiscountAdd {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order which has been discounted.
"""
order: Order
orderErrors: [OrderError!]!
}
input OrderDiscountCommonInput {
"""
Type of the discount: fixed or percent
"""
valueType: DiscountValueTypeEnum!
"""
Value of the discount. Can store fixed value or percent value
"""
value: PositiveDecimal!
"""
Explanation for the applied discount.
"""
reason: String
}
"""
Update discount for the order.
"""
type OrderDiscountUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order which has been discounted.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Remove discount from the order.
"""
type OrderDiscountDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order which has removed discount.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Update discount for the order line.
"""
type OrderLineDiscountUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order line which has been discounted.
"""
orderLine: OrderLine
"""
Order which is related to the discounted line.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Remove discount applied to the order line.
"""
type OrderLineDiscountRemove {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order line which has removed discount.
"""
orderLine: OrderLine
"""
Order which is related to line which has removed discount.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Mark order as manually paid.
"""
type OrderMarkAsPaid {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order marked as paid.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Refund an order.
"""
type OrderRefund {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A refunded order.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Updates an order.
"""
type OrderUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
orderErrors: [OrderError!]!
order: Order
}
input OrderUpdateInput {
"""
Billing address of the customer.
"""
billingAddress: AddressInput
"""
Email address of the customer.
"""
userEmail: String
"""
Shipping address of the customer.
"""
shippingAddress: AddressInput
}
"""
Updates a shipping method of the order.
"""
type OrderUpdateShipping {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order with updated shipping method.
"""
order: Order
orderErrors: [OrderError!]!
}
input OrderUpdateShippingInput {
"""
ID of the selected shipping method.
"""
shippingMethod: ID
}
"""
Void an order.
"""
type OrderVoid {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A voided order.
"""
order: Order
orderErrors: [OrderError!]!
}
"""
Cancels orders.
"""
type OrderBulkCancel {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
orderErrors: [OrderError!]!
}
"""
Delete metadata of an object.
"""
type DeleteMetadata {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
type MetadataError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: MetadataErrorCode!
}
"""
An enumeration.
"""
enum MetadataErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
}
"""
Delete object's private metadata.
"""
type DeletePrivateMetadata {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
"""
Updates metadata of an object.
"""
type UpdateMetadata {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
"""
Updates private metadata of an object.
"""
type UpdatePrivateMetadata {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
"""
Assigns storefront's navigation menus.
"""
type AssignNavigation {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Assigned navigation menu.
"""
menu: Menu
menuErrors: [MenuError!]!
}
type MenuError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: MenuErrorCode!
}
"""
An enumeration.
"""
enum MenuErrorCode {
CANNOT_ASSIGN_NODE
GRAPHQL_ERROR
INVALID
INVALID_MENU_ITEM
NO_MENU_ITEM_PROVIDED
NOT_FOUND
REQUIRED
TOO_MANY_MENU_ITEMS
UNIQUE
}
enum NavigationType {
"""
Main storefront navigation.
"""
MAIN
"""
Secondary storefront navigation.
"""
SECONDARY
}
"""
Creates a new Menu.
"""
type MenuCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
menuErrors: [MenuError!]!
menu: Menu
}
input MenuCreateInput {
"""
Name of the menu.
"""
name: String!
"""
Slug of the menu. Will be generated if not provided.
"""
slug: String
"""
List of menu items.
"""
items: [MenuItemInput]
}
input MenuItemInput {
"""
Name of the menu item.
"""
name: String
"""
URL of the pointed item.
"""
url: String
"""
Category to which item points.
"""
category: ID
"""
Collection to which item points.
"""
collection: ID
"""
Page to which item points.
"""
page: ID
}
"""
Deletes a menu.
"""
type MenuDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
menuErrors: [MenuError!]!
menu: Menu
}
"""
Deletes menus.
"""
type MenuBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
menuErrors: [MenuError!]!
}
"""
Updates a menu.
"""
type MenuUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
menuErrors: [MenuError!]!
menu: Menu
}
input MenuInput {
"""
Name of the menu.
"""
name: String
"""
Slug of the menu.
"""
slug: String
}
"""
Creates a new menu item.
"""
type MenuItemCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
menuErrors: [MenuError!]!
menuItem: MenuItem
}
input MenuItemCreateInput {
"""
Name of the menu item.
"""
name: String!
"""
URL of the pointed item.
"""
url: String
"""
Category to which item points.
"""
category: ID
"""
Collection to which item points.
"""
collection: ID
"""
Page to which item points.
"""
page: ID
"""
Menu to which item belongs.
"""
menu: ID!
"""
ID of the parent menu. If empty, menu will be top level menu.
"""
parent: ID
}
"""
Deletes a menu item.
"""
type MenuItemDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
menuErrors: [MenuError!]!
menuItem: MenuItem
}
"""
Deletes menu items.
"""
type MenuItemBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
menuErrors: [MenuError!]!
}
"""
Updates a menu item.
"""
type MenuItemUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
menuErrors: [MenuError!]!
menuItem: MenuItem
}
"""
Creates/Updates translations for Menu Item.
"""
type MenuItemTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
menuItem: MenuItem
}
"""
Moves items of menus.
"""
type MenuItemMove {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Assigned menu to move within.
"""
menu: Menu
menuErrors: [MenuError!]!
}
input MenuItemMoveInput {
"""
The menu item ID to move.
"""
itemId: ID!
"""
ID of the parent menu. If empty, menu will be top level menu.
"""
parentId: ID
"""
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.
"""
sortOrder: Int
}
"""
Request an invoice for the order using plugin.
"""
type InvoiceRequest {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Order related to an invoice.
"""
order: Order
invoiceErrors: [InvoiceError!]!
invoice: Invoice
}
type InvoiceError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: InvoiceErrorCode!
}
"""
An enumeration.
"""
enum InvoiceErrorCode {
REQUIRED
NOT_READY
URL_NOT_SET
EMAIL_NOT_SET
NUMBER_NOT_SET
NOT_FOUND
INVALID_STATUS
}
"""
Requests deletion of an invoice.
"""
type InvoiceRequestDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
invoiceErrors: [InvoiceError!]!
invoice: Invoice
}
"""
Creates a ready to send invoice.
"""
type InvoiceCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
invoiceErrors: [InvoiceError!]!
invoice: Invoice
}
input InvoiceCreateInput {
"""
Invoice number.
"""
number: String!
"""
URL of an invoice to download.
"""
url: String!
}
"""
Deletes an invoice.
"""
type InvoiceDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
invoiceErrors: [InvoiceError!]!
invoice: Invoice
}
"""
Updates an invoice.
"""
type InvoiceUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
invoiceErrors: [InvoiceError!]!
invoice: Invoice
}
input UpdateInvoiceInput {
"""
Invoice number
"""
number: String
"""
URL of an invoice to download.
"""
url: String
}
"""
Send an invoice notification to the customer.
"""
type InvoiceSendNotification {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
invoiceErrors: [InvoiceError!]!
invoice: Invoice
}
"""
Activate a gift card.
"""
type GiftCardActivate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A gift card to activate.
"""
giftCard: GiftCard
giftCardErrors: [GiftCardError!]!
}
type GiftCardError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: GiftCardErrorCode!
}
"""
An enumeration.
"""
enum GiftCardErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
"""
Creates a new gift card.
"""
type GiftCardCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
giftCardErrors: [GiftCardError!]!
giftCard: GiftCard
}
input GiftCardCreateInput {
"""
Start date of the gift card in ISO 8601 format.
"""
startDate: Date
"""
End date of the gift card in ISO 8601 format.
"""
endDate: Date
"""
Value of the gift card.
"""
balance: PositiveDecimal
"""
The customer's email of the gift card buyer.
"""
userEmail: String
"""
Code to use the gift card.
"""
code: String
}
"""
Deactivate a gift card.
"""
type GiftCardDeactivate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A gift card to deactivate.
"""
giftCard: GiftCard
giftCardErrors: [GiftCardError!]!
}
"""
Update a gift card.
"""
type GiftCardUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
giftCardErrors: [GiftCardError!]!
giftCard: GiftCard
}
input GiftCardUpdateInput {
"""
Start date of the gift card in ISO 8601 format.
"""
startDate: Date
"""
End date of the gift card in ISO 8601 format.
"""
endDate: Date
"""
Value of the gift card.
"""
balance: PositiveDecimal
"""
The customer's email of the gift card buyer.
"""
userEmail: String
}
"""
Update plugin configuration.
"""
type PluginUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
plugin: Plugin
pluginsErrors: [PluginError!]!
}
type PluginError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: PluginErrorCode!
}
"""
An enumeration.
"""
enum PluginErrorCode {
GRAPHQL_ERROR
INVALID
PLUGIN_MISCONFIGURED
NOT_FOUND
REQUIRED
UNIQUE
}
input PluginUpdateInput {
"""
Indicates whether the plugin should be enabled.
"""
active: Boolean
"""
Configuration of the plugin.
"""
configuration: [ConfigurationItemInput]
}
input ConfigurationItemInput {
"""
Name of the field to update.
"""
name: String!
"""
Value of the given field to update.
"""
value: String
}
"""
Creates a new sale.
"""
type SaleCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
discountErrors: [DiscountError!]!
sale: Sale
}
type DiscountError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
List of products IDs which causes the error.
"""
products: [ID!]
"""
The error code.
"""
code: DiscountErrorCode!
"""
List of channels IDs which causes the error.
"""
channels: [ID!]
}
"""
An enumeration.
"""
enum DiscountErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT
DUPLICATED_INPUT_ITEM
}
input SaleInput {
"""
Voucher name.
"""
name: String
"""
Fixed or percentage.
"""
type: DiscountValueTypeEnum
"""
Value of the voucher.
"""
value: PositiveDecimal
"""
Products related to the discount.
"""
products: [ID]
"""
Categories related to the discount.
"""
categories: [ID]
"""
Collections related to the discount.
"""
collections: [ID]
"""
Start date of the voucher in ISO 8601 format.
"""
startDate: DateTime
"""
End date of the voucher in ISO 8601 format.
"""
endDate: DateTime
}
"""
Deletes a sale.
"""
type SaleDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
discountErrors: [DiscountError!]!
sale: Sale
}
"""
Deletes sales.
"""
type SaleBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
discountErrors: [DiscountError!]!
}
"""
Updates a sale.
"""
type SaleUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
discountErrors: [DiscountError!]!
sale: Sale
}
"""
Adds products, categories, collections to a voucher.
"""
type SaleAddCatalogues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Sale of which catalogue IDs will be modified.
"""
sale: Sale
discountErrors: [DiscountError!]!
}
input CatalogueInput {
"""
Products related to the discount.
"""
products: [ID]
"""
Categories related to the discount.
"""
categories: [ID]
"""
Collections related to the discount.
"""
collections: [ID]
}
"""
Removes products, categories, collections from a sale.
"""
type SaleRemoveCatalogues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Sale of which catalogue IDs will be modified.
"""
sale: Sale
discountErrors: [DiscountError!]!
}
"""
Creates/updates translations for a sale.
"""
type SaleTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
sale: Sale
}
"""
Manage sale's availability in channels.
"""
type SaleChannelListingUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated sale instance.
"""
sale: Sale
discountErrors: [DiscountError!]!
}
input SaleChannelListingInput {
"""
List of channels to which the sale should be assigned.
"""
addChannels: [SaleChannelListingAddInput!]
"""
List of channels from which the sale should be unassigned.
"""
removeChannels: [ID!]
}
input SaleChannelListingAddInput {
"""
ID of a channel.
"""
channelId: ID!
"""
The value of the discount.
"""
discountValue: PositiveDecimal!
}
"""
Creates a new voucher.
"""
type VoucherCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
discountErrors: [DiscountError!]!
voucher: Voucher
}
input VoucherInput {
"""
Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER.
"""
type: VoucherTypeEnum
"""
Voucher name.
"""
name: String
"""
Code to use the voucher.
"""
code: String
"""
Start date of the voucher in ISO 8601 format.
"""
startDate: DateTime
"""
End date of the voucher in ISO 8601 format.
"""
endDate: DateTime
"""
Choices: fixed or percentage.
"""
discountValueType: DiscountValueTypeEnum
"""
Products discounted by the voucher.
"""
products: [ID]
"""
Collections discounted by the voucher.
"""
collections: [ID]
"""
Categories discounted by the voucher.
"""
categories: [ID]
"""
Minimal quantity of checkout items required to apply the voucher.
"""
minCheckoutItemsQuantity: Int
"""
Country codes that can be used with the shipping voucher.
"""
countries: [String]
"""
Voucher should be applied to the cheapest item or entire order.
"""
applyOncePerOrder: Boolean
"""
Voucher should be applied once per customer.
"""
applyOncePerCustomer: Boolean
"""
Limit number of times this voucher can be used in total.
"""
usageLimit: Int
}
"""
Deletes a voucher.
"""
type VoucherDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
discountErrors: [DiscountError!]!
voucher: Voucher
}
"""
Deletes vouchers.
"""
type VoucherBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
discountErrors: [DiscountError!]!
}
"""
Updates a voucher.
"""
type VoucherUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
discountErrors: [DiscountError!]!
voucher: Voucher
}
"""
Adds products, categories, collections to a voucher.
"""
type VoucherAddCatalogues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Voucher of which catalogue IDs will be modified.
"""
voucher: Voucher
discountErrors: [DiscountError!]!
}
"""
Removes products, categories, collections from a voucher.
"""
type VoucherRemoveCatalogues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Voucher of which catalogue IDs will be modified.
"""
voucher: Voucher
discountErrors: [DiscountError!]!
}
"""
Creates/Updates translations for Voucher.
"""
type VoucherTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
voucher: Voucher
}
"""
Manage voucher's availability in channels.
"""
type VoucherChannelListingUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated voucher instance.
"""
voucher: Voucher
discountErrors: [DiscountError!]!
}
input VoucherChannelListingInput {
"""
List of channels to which the voucher should be assigned.
"""
addChannels: [VoucherChannelListingAddInput!]
"""
List of channels from which the voucher should be unassigned.
"""
removeChannels: [ID!]
}
input VoucherChannelListingAddInput {
"""
ID of a channel.
"""
channelId: ID!
"""
Value of the voucher.
"""
discountValue: PositiveDecimal
"""
Min purchase amount required to apply the voucher.
"""
minAmountSpent: PositiveDecimal
}
"""
Export products to csv file.
"""
type ExportProducts {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The newly created export file job which is responsible for export data.
"""
exportFile: ExportFile
exportErrors: [ExportError!]!
}
type ExportError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ExportErrorCode!
}
"""
An enumeration.
"""
enum ExportErrorCode {
INVALID
NOT_FOUND
REQUIRED
}
input ExportProductsInput {
"""
Determine which products should be exported.
"""
scope: ExportScope!
"""
Filtering options for products.
"""
filter: ProductFilterInput
"""
List of products IDS to export.
"""
ids: [ID!]
"""
Input with info about fields which should be exported.
"""
exportInfo: ExportInfoInput
"""
Type of exported file.
"""
fileType: FileTypesEnum!
}
enum ExportScope {
"""
Export all products.
"""
ALL
"""
Export products with given ids.
"""
IDS
"""
Export the filtered products.
"""
FILTER
}
input ExportInfoInput {
"""
List of attribute ids witch should be exported.
"""
attributes: [ID!]
"""
List of warehouse ids witch should be exported.
"""
warehouses: [ID!]
"""
List of channels ids which should be exported.
"""
channels: [ID!]
"""
List of product fields witch should be exported.
"""
fields: [ProductFieldEnum!]
}
enum ProductFieldEnum {
NAME
DESCRIPTION
PRODUCT_TYPE
CATEGORY
VISIBLE
PRODUCT_WEIGHT
COLLECTIONS
CHARGE_TAXES
PRODUCT_MEDIA
VARIANT_SKU
VARIANT_WEIGHT
VARIANT_MEDIA
}
"""
An enumeration.
"""
enum FileTypesEnum {
CSV
XLSX
}
"""
Upload a file. 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
"""
type FileUpload {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
uploadedFile: File
uploadErrors: [UploadError!]!
}
type UploadError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: UploadErrorCode!
}
"""
An enumeration.
"""
enum UploadErrorCode {
GRAPHQL_ERROR
}
"""
Adds a gift card or a voucher to a checkout.
"""
type CheckoutAddPromoCode {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The checkout with the added gift card or voucher.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
type CheckoutError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: CheckoutErrorCode!
"""
List of varint IDs which causes the error.
"""
variants: [ID!]
}
"""
An enumeration.
"""
enum CheckoutErrorCode {
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
MISSING_CHANNEL_SLUG
CHANNEL_INACTIVE
UNAVAILABLE_VARIANT_IN_CHANNEL
}
"""
Update billing address in the existing checkout.
"""
type CheckoutBillingAddressUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
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.
"""
type CheckoutComplete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Placed order.
"""
order: Order
"""
Set to true if payment needs to be confirmed before checkout is complete.
"""
confirmationNeeded: Boolean!
"""
Confirmation data used to process additional authorization steps.
"""
confirmationData: JSONString
checkoutErrors: [CheckoutError!]!
}
"""
Create a new checkout.
"""
type CheckoutCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
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.
"""
created: Boolean
checkoutErrors: [CheckoutError!]!
checkout: Checkout
}
input CheckoutCreateInput {
"""
Slug of a channel in which to create a checkout.
"""
channel: String
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLineInput]!
"""
The customer's email address.
"""
email: String
"""
The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items.
"""
shippingAddress: AddressInput
"""
Billing address of the customer.
"""
billingAddress: AddressInput
"""
Checkout language code.
"""
languageCode: LanguageCodeEnum
}
input CheckoutLineInput {
"""
The number of items purchased.
"""
quantity: Int!
"""
ID of the product variant.
"""
variantId: ID!
}
"""
Sets the customer as the owner of the checkout.
"""
type CheckoutCustomerAttach {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Removes the user assigned as the owner of the checkout.
"""
type CheckoutCustomerDetach {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Updates email address in the existing checkout object.
"""
type CheckoutEmailUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Deletes a CheckoutLine.
"""
type CheckoutLineDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Adds a checkout line to the existing checkout.
"""
type CheckoutLinesAdd {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Updates checkout line in the existing checkout.
"""
type CheckoutLinesUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Remove a gift card or a voucher from a checkout.
"""
type CheckoutRemovePromoCode {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The checkout with the removed gift card or voucher.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Create a new payment for given checkout.
"""
type CheckoutPaymentCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Related checkout object.
"""
checkout: Checkout
"""
A newly created payment.
"""
payment: Payment
paymentErrors: [PaymentError!]!
}
input PaymentInput {
"""
A gateway to use with that payment.
"""
gateway: String!
"""
Client-side generated payment token, representing customer's billing data in a secure manner.
"""
token: String
"""
Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used.
"""
amount: PositiveDecimal
"""
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.
"""
returnUrl: String
}
"""
Update shipping address in the existing checkout.
"""
type CheckoutShippingAddressUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Updates the shipping address of the checkout.
"""
type CheckoutShippingMethodUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Update language code in the existing checkout.
"""
type CheckoutLanguageCodeUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated checkout.
"""
checkout: Checkout
checkoutErrors: [CheckoutError!]!
}
"""
Creates new channel.
"""
type ChannelCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
channelErrors: [ChannelError!]!
channel: Channel
}
type ChannelError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: ChannelErrorCode!
"""
List of shipping zone IDs which causes the error.
"""
shippingZones: [ID!]
}
"""
An enumeration.
"""
enum ChannelErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
CHANNEL_TARGET_ID_MUST_BE_DIFFERENT
CHANNELS_CURRENCY_MUST_BE_THE_SAME
CHANNEL_WITH_ORDERS
DUPLICATED_INPUT_ITEM
}
input ChannelCreateInput {
"""
isActive flag.
"""
isActive: Boolean
"""
Name of the channel.
"""
name: String!
"""
Slug of the channel.
"""
slug: String!
"""
Currency of the channel.
"""
currencyCode: String!
"""
List of shipping zones to assign to the channel.
"""
addShippingZones: [ID!]
}
"""
Update a channel.
"""
type ChannelUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
channelErrors: [ChannelError!]!
channel: Channel
}
input ChannelUpdateInput {
"""
isActive flag.
"""
isActive: Boolean
"""
Name of the channel.
"""
name: String
"""
Slug of the channel.
"""
slug: String
"""
List of shipping zones to assign to the channel.
"""
addShippingZones: [ID!]
"""
List of shipping zones to unassign from the channel.
"""
removeShippingZones: [ID!]
}
"""
Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.
"""
type ChannelDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
channelErrors: [ChannelError!]!
channel: Channel
}
input ChannelDeleteInput {
"""
ID of channel to migrate orders from origin channel.
"""
targetChannel: ID!
}
"""
Activate a channel.
"""
type ChannelActivate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Activated channel.
"""
channel: Channel
channelErrors: [ChannelError!]!
}
"""
Deactivate a channel.
"""
type ChannelDeactivate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Deactivated channel.
"""
channel: Channel
channelErrors: [ChannelError!]!
}
"""
Creates an attribute.
"""
type AttributeCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
attribute: Attribute
attributeErrors: [AttributeError!]!
}
type AttributeError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: AttributeErrorCode!
}
"""
An enumeration.
"""
enum AttributeErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input AttributeCreateInput {
"""
The input type to use for entering attribute values in the dashboard.
"""
inputType: AttributeInputTypeEnum
"""
The entity type which can be used as a reference.
"""
entityType: AttributeEntityTypeEnum
"""
Name of an attribute displayed in the interface.
"""
name: String!
"""
Internal representation of an attribute name.
"""
slug: String
"""
The attribute type.
"""
type: AttributeTypeEnum!
"""
List of attribute's values.
"""
values: [AttributeValueCreateInput]
"""
Whether the attribute requires values to be passed or not.
"""
valueRequired: Boolean
"""
Whether the attribute is for variants only.
"""
isVariantOnly: Boolean
"""
Whether the attribute should be visible or not in storefront.
"""
visibleInStorefront: Boolean
"""
Whether the attribute can be filtered in storefront.
"""
filterableInStorefront: Boolean
"""
Whether the attribute can be filtered in dashboard.
"""
filterableInDashboard: Boolean
"""
The position of the attribute in the storefront navigation (0 by default).
"""
storefrontSearchPosition: Int
"""
Whether the attribute can be displayed in the admin product list.
"""
availableInGrid: Boolean
}
input AttributeValueCreateInput {
"""
Name of a value displayed in the interface.
"""
name: String!
"""
Represents the value of the attribute value.
"""
value: String
"""
Represents the text (JSON) of the attribute value.
"""
richText: JSONString
}
"""
Deletes an attribute.
"""
type AttributeDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
attributeErrors: [AttributeError!]!
attribute: Attribute
}
"""
Updates attribute.
"""
type AttributeUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
attribute: Attribute
attributeErrors: [AttributeError!]!
}
input AttributeUpdateInput {
"""
Name of an attribute displayed in the interface.
"""
name: String
"""
Internal representation of an attribute name.
"""
slug: String
"""
IDs of values to be removed from this attribute.
"""
removeValues: [ID]
"""
New values to be created for this attribute.
"""
addValues: [AttributeValueCreateInput]
"""
Whether the attribute requires values to be passed or not.
"""
valueRequired: Boolean
"""
Whether the attribute is for variants only.
"""
isVariantOnly: Boolean
"""
Whether the attribute should be visible or not in storefront.
"""
visibleInStorefront: Boolean
"""
Whether the attribute can be filtered in storefront.
"""
filterableInStorefront: Boolean
"""
Whether the attribute can be filtered in dashboard.
"""
filterableInDashboard: Boolean
"""
The position of the attribute in the storefront navigation (0 by default).
"""
storefrontSearchPosition: Int
"""
Whether the attribute can be displayed in the admin product list.
"""
availableInGrid: Boolean
}
"""
Creates/Updates translations for attribute.
"""
type AttributeTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
attribute: Attribute
}
"""
Deletes attributes.
"""
type AttributeBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
attributeErrors: [AttributeError!]!
}
"""
Deletes values of attributes.
"""
type AttributeValueBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
attributeErrors: [AttributeError!]!
}
"""
Creates a value for an attribute.
"""
type AttributeValueCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The updated attribute.
"""
attribute: Attribute
attributeErrors: [AttributeError!]!
attributeValue: AttributeValue
}
"""
Deletes a value of an attribute.
"""
type AttributeValueDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The updated attribute.
"""
attribute: Attribute
attributeErrors: [AttributeError!]!
attributeValue: AttributeValue
}
"""
Updates value of an attribute.
"""
type AttributeValueUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The updated attribute.
"""
attribute: Attribute
attributeErrors: [AttributeError!]!
attributeValue: AttributeValue
}
"""
Creates/Updates translations for attribute value.
"""
type AttributeValueTranslate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
translationErrors: [TranslationError!]!
attributeValue: AttributeValue
}
input AttributeValueTranslationInput {
name: String
richText: JSONString
}
"""
Reorder the values of an attribute.
"""
type AttributeReorderValues {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Attribute from which values are reordered.
"""
attribute: Attribute
attributeErrors: [AttributeError!]!
}
"""
Creates a new app.
"""
type AppCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The newly created authentication token.
"""
authToken: String
appErrors: [AppError!]!
app: App
}
type AppError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: AppErrorCode!
"""
List of permissions which causes the error.
"""
permissions: [PermissionEnum!]
}
"""
An enumeration.
"""
enum AppErrorCode {
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
}
input AppInput {
"""
Name of the app.
"""
name: String
"""
DEPRECATED: Use the `appActivate` and `appDeactivate` mutations instead. This field will be removed after 2020-07-31.
"""
isActive: Boolean
"""
List of permission code names to assign to this app.
"""
permissions: [PermissionEnum]
}
"""
Updates an existing app.
"""
type AppUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
app: App
}
"""
Deletes an app.
"""
type AppDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
app: App
}
"""
Creates a new token.
"""
type AppTokenCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The newly created authentication token.
"""
authToken: String
appErrors: [AppError!]!
appToken: AppToken
}
input AppTokenInput {
"""
Name of the token.
"""
name: String
"""
ID of app.
"""
app: ID!
}
"""
Deletes an authentication token assigned to app.
"""
type AppTokenDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
appToken: AppToken
}
"""
Verify provided app token.
"""
type AppTokenVerify {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Determine if token is valid or not.
"""
valid: Boolean!
appErrors: [AppError!]!
}
"""
Install new app by using app manifest.
"""
type AppInstall {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
appInstallation: AppInstallation
}
input AppInstallInput {
"""
Name of the app to install.
"""
appName: String
"""
Url to app's manifest in JSON format.
"""
manifestUrl: String
"""
Determine if app will be set active or not.
"""
activateAfterInstallation: Boolean
"""
List of permission code names to assign to this app.
"""
permissions: [PermissionEnum]
}
"""
Retry failed installation of new app.
"""
type AppRetryInstall {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
appInstallation: AppInstallation
}
"""
Delete failed installation.
"""
type AppDeleteFailedInstallation {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
appInstallation: AppInstallation
}
"""
Fetch and validate manifest.
"""
type AppFetchManifest {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
manifest: Manifest
appErrors: [AppError!]!
}
"""
The manifest definition.
"""
type Manifest {
identifier: String!
version: String!
name: String!
about: String
permissions: [Permission]
appUrl: String
configurationUrl: String
tokenTargetUrl: String
dataPrivacy: String
dataPrivacyUrl: String
homepageUrl: String
supportUrl: String
}
"""
Activate the app.
"""
type AppActivate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
app: App
}
"""
Deactivate the app.
"""
type AppDeactivate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
appErrors: [AppError!]!
app: App
}
"""
Create JWT token.
"""
type CreateToken {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
JWT token, required to authenticate.
"""
token: String
"""
JWT refresh token, required to re-generate access token.
"""
refreshToken: String
"""
CSRF token required to re-generate access token.
"""
csrfToken: String
"""
A user instance.
"""
user: User
accountErrors: [AccountError!]!
}
type AccountError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: AccountErrorCode!
}
"""
An enumeration.
"""
enum AccountErrorCode {
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
INACTIVE
INVALID
INVALID_PASSWORD
LEFT_NOT_MANAGEABLE_PERMISSION
INVALID_CREDENTIALS
NOT_FOUND
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
}
"""
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.
"""
type RefreshToken {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
JWT token, required to authenticate.
"""
token: String
"""
A user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Verify JWT token.
"""
type VerifyToken {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
User assigned to token.
"""
user: User
"""
Determine if token is valid or not.
"""
isValid: Boolean!
"""
JWT payload.
"""
payload: GenericScalar
accountErrors: [AccountError!]!
}
"""
The `GenericScalar` scalar type represents a generic
GraphQL scalar value that could be:
String, Boolean, Int, Float, List or Object.
"""
scalar GenericScalar
"""
Deactivate all JWT tokens of the currently authenticated user.
"""
type DeactivateAllUserTokens {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
}
"""
Prepare external authentication url for user by custom plugin.
"""
type ExternalAuthenticationUrl {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The data returned by authentication plugin.
"""
authenticationData: JSONString
accountErrors: [AccountError!]!
}
"""
Obtain external access tokens for user by custom plugin.
"""
type ExternalObtainAccessTokens {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The token, required to authenticate.
"""
token: String
"""
The refresh token, required to re-generate external access token.
"""
refreshToken: String
"""
CSRF token required to re-generate external access token.
"""
csrfToken: String
"""
A user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Refresh user's access by custom plugin.
"""
type ExternalRefresh {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The token, required to authenticate.
"""
token: String
"""
The refresh token, required to re-generate external access token.
"""
refreshToken: String
"""
CSRF token required to re-generate external access token.
"""
csrfToken: String
"""
A user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Logout user by custom plugin.
"""
type ExternalLogout {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
The data returned by authentication plugin.
"""
logoutData: JSONString
accountErrors: [AccountError!]!
}
"""
Verify external authentication data by plugin.
"""
type ExternalVerify {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
User assigned to data.
"""
user: User
"""
Determine if authentication data is valid or not.
"""
isValid: Boolean!
"""
External data.
"""
verifyData: JSONString
accountErrors: [AccountError!]!
}
"""
Sends an email with the account password modification link.
"""
type RequestPasswordReset {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
}
"""
Confirm user account with token sent by email during registration.
"""
type ConfirmAccount {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An activated user account.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Sets the user's password from the token sent by email using the RequestPasswordReset mutation.
"""
type SetPassword {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
JWT token, required to authenticate.
"""
token: String
"""
JWT refresh token, required to re-generate access token.
"""
refreshToken: String
"""
CSRF token required to re-generate access token.
"""
csrfToken: String
"""
A user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Change the password of the logged in user.
"""
type PasswordChange {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user instance with a new password.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Request email change of the logged in user.
"""
type RequestEmailChange {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Confirm the email change of the logged-in user.
"""
type ConfirmEmailChange {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user instance with a new email.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Create a new address for the customer.
"""
type AccountAddressCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user instance for which the address was created.
"""
user: User
accountErrors: [AccountError!]!
address: Address
}
"""
An enumeration.
"""
enum AddressTypeEnum {
BILLING
SHIPPING
}
"""
Updates an address of the logged-in user.
"""
type AccountAddressUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user object for which the address was edited.
"""
user: User
accountErrors: [AccountError!]!
address: Address
}
"""
Delete an address of the logged-in user.
"""
type AccountAddressDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user instance for which the address was deleted.
"""
user: User
accountErrors: [AccountError!]!
address: Address
}
"""
Sets a default address for the authenticated user.
"""
type AccountSetDefaultAddress {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Register a new user.
"""
type AccountRegister {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Informs whether users need to confirm their email address.
"""
requiresConfirmation: Boolean
accountErrors: [AccountError!]!
user: User
}
input AccountRegisterInput {
"""
The email address of the user.
"""
email: String!
"""
Password.
"""
password: String!
"""
Base of frontend URL that will be needed to create confirmation URL.
"""
redirectUrl: String
"""
User language code.
"""
languageCode: LanguageCodeEnum
"""
User public metadata.
"""
metadata: [MetadataInput!]
}
"""
Updates the account of the logged-in user.
"""
type AccountUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
user: User
}
input AccountInput {
"""
Given name.
"""
firstName: String
"""
Family name.
"""
lastName: String
"""
Billing address of the customer.
"""
defaultBillingAddress: AddressInput
"""
Shipping address of the customer.
"""
defaultShippingAddress: AddressInput
"""
User language code.
"""
languageCode: LanguageCodeEnum
}
"""
Sends an email with the account removal link for the logged-in user.
"""
type AccountRequestDeletion {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
}
"""
Remove user account.
"""
type AccountDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
user: User
}
"""
Creates user address.
"""
type AddressCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user instance for which the address was created.
"""
user: User
accountErrors: [AccountError!]!
address: Address
}
"""
Updates an address.
"""
type AddressUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user object for which the address was edited.
"""
user: User
accountErrors: [AccountError!]!
address: Address
}
"""
Deletes an address.
"""
type AddressDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
A user instance for which the address was deleted.
"""
user: User
accountErrors: [AccountError!]!
address: Address
}
"""
Sets a default address for the given user.
"""
type AddressSetDefault {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Creates a new customer.
"""
type CustomerCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
user: User
}
input UserCreateInput {
"""
Billing address of the customer.
"""
defaultBillingAddress: AddressInput
"""
Shipping address of the customer.
"""
defaultShippingAddress: AddressInput
"""
Given name.
"""
firstName: String
"""
Family name.
"""
lastName: String
"""
The unique email address of the user.
"""
email: String
"""
User account is active.
"""
isActive: Boolean
"""
A note about the user.
"""
note: String
"""
User language code.
"""
languageCode: LanguageCodeEnum
"""
URL of a view where users should be redirected to set the password. URL in RFC 1808 format.
"""
redirectUrl: String
}
"""
Updates an existing customer.
"""
type CustomerUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
user: User
}
input CustomerInput {
"""
Billing address of the customer.
"""
defaultBillingAddress: AddressInput
"""
Shipping address of the customer.
"""
defaultShippingAddress: AddressInput
"""
Given name.
"""
firstName: String
"""
Family name.
"""
lastName: String
"""
The unique email address of the user.
"""
email: String
"""
User account is active.
"""
isActive: Boolean
"""
A note about the user.
"""
note: String
"""
User language code.
"""
languageCode: LanguageCodeEnum
}
"""
Deletes a customer.
"""
type CustomerDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
accountErrors: [AccountError!]!
user: User
}
"""
Deletes customers.
"""
type CustomerBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
accountErrors: [AccountError!]!
}
"""
Creates a new staff user.
"""
type StaffCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
staffErrors: [StaffError!]!
user: User
}
type StaffError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: AccountErrorCode!
"""
List of permissions which causes the error.
"""
permissions: [PermissionEnum!]
"""
List of permission group IDs which cause the error.
"""
groups: [ID!]
"""
List of user IDs which causes the error.
"""
users: [ID!]
}
input StaffCreateInput {
"""
Given name.
"""
firstName: String
"""
Family name.
"""
lastName: String
"""
The unique email address of the user.
"""
email: String
"""
User account is active.
"""
isActive: Boolean
"""
A note about the user.
"""
note: String
"""
List of permission group IDs to which user should be assigned.
"""
addGroups: [ID!]
"""
URL of a view where users should be redirected to set the password. URL in RFC 1808 format.
"""
redirectUrl: String
}
"""
Updates an existing staff user.
"""
type StaffUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
staffErrors: [StaffError!]!
user: User
}
input StaffUpdateInput {
"""
Given name.
"""
firstName: String
"""
Family name.
"""
lastName: String
"""
The unique email address of the user.
"""
email: String
"""
User account is active.
"""
isActive: Boolean
"""
A note about the user.
"""
note: String
"""
List of permission group IDs to which user should be assigned.
"""
addGroups: [ID!]
"""
List of permission group IDs from which user should be unassigned.
"""
removeGroups: [ID!]
}
"""
Deletes a staff user.
"""
type StaffDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
staffErrors: [StaffError!]!
user: User
}
"""
Deletes staff users.
"""
type StaffBulkDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
staffErrors: [StaffError!]!
}
"""
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
"""
type UserAvatarUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Deletes a user avatar. Only for staff members.
"""
type UserAvatarDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
An updated user instance.
"""
user: User
accountErrors: [AccountError!]!
}
"""
Activate or deactivate users.
"""
type UserBulkSetActive {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
"""
Returns how many objects were affected.
"""
count: Int!
accountErrors: [AccountError!]!
}
"""
Create new permission group.
"""
type PermissionGroupCreate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
permissionGroupErrors: [PermissionGroupError!]!
group: Group
}
type PermissionGroupError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""
The error message.
"""
message: String
"""
The error code.
"""
code: PermissionGroupErrorCode!
"""
List of permissions which causes the error.
"""
permissions: [PermissionEnum!]
"""
List of user IDs which causes the error.
"""
users: [ID!]
}
"""
An enumeration.
"""
enum PermissionGroupErrorCode {
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
}
input PermissionGroupCreateInput {
"""
List of permission code names to assign to this group.
"""
addPermissions: [PermissionEnum!]
"""
List of users to assign to this group.
"""
addUsers: [ID!]
"""
Group name.
"""
name: String!
}
"""
Update permission group.
"""
type PermissionGroupUpdate {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
permissionGroupErrors: [PermissionGroupError!]!
group: Group
}
input PermissionGroupUpdateInput {
"""
List of permission code names to assign to this group.
"""
addPermissions: [PermissionEnum!]
"""
List of users to assign to this group.
"""
addUsers: [ID!]
"""
Group name.
"""
name: String
"""
List of permission code names to unassign from this group.
"""
removePermissions: [PermissionEnum!]
"""
List of users to unassign from this group.
"""
removeUsers: [ID!]
}
"""
Delete permission group.
"""
type PermissionGroupDelete {
"""
List of errors that occurred executing the mutation.
"""
errors: [Error!]!
@deprecated(
reason: "Use typed errors with error codes. This field will be removed after 2020-07-31."
)
permissionGroupErrors: [PermissionGroupError!]!
group: Group
}
Reference in New Issue View Git Blame Copy Permalink