saleor-dashboard/schema.graphql

5326 lines
141 KiB
GraphQL
Raw Normal View History

2019-08-12 13:07:51 +00:00
schema {
query: Query
2019-10-17 15:29:13 +00:00
mutation: Mutation
2019-08-12 13:07:51 +00:00
}
type AccountAddressCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
address: Address
}
type AccountAddressDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
address: Address
}
type AccountAddressUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
address: Address
}
type AccountDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
2019-09-26 10:14:07 +00:00
type AccountError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: AccountErrorCode!
2019-09-26 10:14:07 +00:00
}
enum AccountErrorCode {
ACTIVATE_OWN_ACCOUNT
ACTIVATE_SUPERUSER_ACCOUNT
DUPLICATED_INPUT_ITEM
2019-09-26 10:14:07 +00:00
DEACTIVATE_OWN_ACCOUNT
DEACTIVATE_SUPERUSER_ACCOUNT
DELETE_NON_STAFF_USER
DELETE_OWN_ACCOUNT
DELETE_STAFF_ACCOUNT
DELETE_SUPERUSER_ACCOUNT
GRAPHQL_ERROR
INVALID
INVALID_PASSWORD
2020-04-20 11:11:07 +00:00
LEFT_NOT_MANAGEABLE_PERMISSION
INVALID_CREDENTIALS
2019-09-26 10:14:07 +00:00
NOT_FOUND
2020-04-22 14:41:07 +00:00
OUT_OF_SCOPE_SERVICE_ACCOUNT
2020-04-20 11:11:07 +00:00
OUT_OF_SCOPE_USER
OUT_OF_SCOPE_GROUP
OUT_OF_SCOPE_PERMISSION
2019-09-26 10:14:07 +00:00
PASSWORD_ENTIRELY_NUMERIC
PASSWORD_TOO_COMMON
PASSWORD_TOO_SHORT
PASSWORD_TOO_SIMILAR
REQUIRED
UNIQUE
2020-07-01 11:11:08 +00:00
JWT_SIGNATURE_EXPIRED
JWT_INVALID_TOKEN
JWT_DECODE_ERROR
JWT_MISSING_TOKEN
JWT_INVALID_CSRF_TOKEN
2019-09-26 10:14:07 +00:00
}
2019-08-12 13:07:51 +00:00
input AccountInput {
firstName: String
lastName: String
defaultBillingAddress: AddressInput
defaultShippingAddress: AddressInput
}
type AccountRegister {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-12-30 12:55:37 +00:00
requiresConfirmation: Boolean
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
input AccountRegisterInput {
email: String!
password: String!
2020-03-03 11:20:39 +00:00
redirectUrl: String
2019-08-12 13:07:51 +00:00
}
type AccountRequestDeletion {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type AccountSetDefaultAddress {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type AccountUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
2019-10-25 12:18:52 +00:00
type AccountUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-10-25 12:18:52 +00:00
user: User
}
2019-08-12 13:07:51 +00:00
type Address implements Node {
id: ID!
firstName: String!
lastName: String!
companyName: String!
streetAddress1: String!
streetAddress2: String!
city: String!
cityArea: String!
postalCode: String!
country: CountryDisplay!
countryArea: String!
phone: String
isDefaultShippingAddress: Boolean
isDefaultBillingAddress: Boolean
}
type AddressCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
address: Address
}
type AddressDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
address: Address
}
input AddressInput {
firstName: String
lastName: String
companyName: String
streetAddress1: String
streetAddress2: String
city: String
cityArea: String
postalCode: String
2019-10-25 12:18:52 +00:00
country: CountryCode
2019-08-12 13:07:51 +00:00
countryArea: String
phone: String
}
type AddressSetDefault {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
enum AddressTypeEnum {
BILLING
SHIPPING
}
type AddressUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
address: Address
}
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
}
2020-04-22 14:41:07 +00:00
type App implements Node & ObjectWithMetadata {
id: ID!
name: String
created: DateTime
isActive: Boolean
permissions: [Permission]
tokens: [AppToken]
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
webhooks: [Webhook]
}
type AppCountableConnection {
pageInfo: PageInfo!
edges: [AppCountableEdge!]!
totalCount: Int
}
type AppCountableEdge {
node: App!
cursor: String!
}
type AppCreate {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
authToken: String
appErrors: [AppError!]!
app: App
}
type AppDelete {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
appErrors: [AppError!]!
app: App
}
type AppError {
field: String
message: String
code: AppErrorCode!
permissions: [PermissionEnum!]
}
enum AppErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
OUT_OF_SCOPE_APP
OUT_OF_SCOPE_PERMISSION
}
input AppFilterInput {
search: String
isActive: Boolean
}
input AppInput {
name: String
isActive: Boolean
permissions: [PermissionEnum]
}
enum AppSortField {
NAME
CREATION_DATE
}
input AppSortingInput {
direction: OrderDirection!
field: AppSortField!
}
type AppToken implements Node {
name: String
authToken: String
id: ID!
}
type AppTokenCreate {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
authToken: String
appErrors: [AppError!]!
appToken: AppToken
}
type AppTokenDelete {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
appErrors: [AppError!]!
appToken: AppToken
}
input AppTokenInput {
name: String
app: ID!
}
2020-06-10 13:39:10 +00:00
type AppTokenVerify {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
valid: Boolean!
appErrors: [AppError!]!
}
2020-04-22 14:41:07 +00:00
type AppUpdate {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
appErrors: [AppError!]!
app: App
}
2019-08-12 13:07:51 +00:00
type AssignNavigation {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
menu: Menu
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
}
2020-03-03 11:20:39 +00:00
type Attribute implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
id: ID!
2020-04-22 14:41:07 +00:00
productTypes(before: String, after: String, first: Int, last: Int): ProductTypeCountableConnection!
productVariantTypes(before: String, after: String, first: Int, last: Int): ProductTypeCountableConnection!
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
inputType: AttributeInputTypeEnum
name: String
slug: String
values: [AttributeValue]
valueRequired: Boolean!
visibleInStorefront: Boolean!
filterableInStorefront: Boolean!
filterableInDashboard: Boolean!
availableInGrid: Boolean!
translation(languageCode: LanguageCodeEnum!): AttributeTranslation
storefrontSearchPosition: Int!
}
type AttributeAssign {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
productType: ProductType
2020-04-20 11:11:07 +00:00
productErrors: [ProductAttributeError!]!
2019-08-12 13:07:51 +00:00
}
input AttributeAssignInput {
id: ID!
type: AttributeTypeEnum!
}
type AttributeBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type AttributeClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attribute: Attribute
}
type AttributeClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attribute: Attribute
}
type AttributeCountableConnection {
pageInfo: PageInfo!
edges: [AttributeCountableEdge!]!
totalCount: Int
}
type AttributeCountableEdge {
node: Attribute!
cursor: String!
}
type AttributeCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
attribute: Attribute
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
input AttributeCreateInput {
inputType: AttributeInputTypeEnum
name: String!
slug: String
values: [AttributeValueCreateInput]
valueRequired: Boolean
isVariantOnly: Boolean
visibleInStorefront: Boolean
filterableInStorefront: Boolean
filterableInDashboard: Boolean
storefrontSearchPosition: Int
availableInGrid: Boolean
}
type AttributeDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attribute: Attribute
}
input AttributeFilterInput {
valueRequired: Boolean
isVariantOnly: Boolean
visibleInStorefront: Boolean
filterableInStorefront: Boolean
filterableInDashboard: Boolean
availableInGrid: Boolean
search: String
2019-08-28 14:53:57 +00:00
ids: [ID]
2019-09-26 15:06:14 +00:00
inCollection: ID
inCategory: ID
2019-08-12 13:07:51 +00:00
}
input AttributeInput {
slug: String!
2020-01-17 15:16:05 +00:00
value: String
values: [String]
2019-08-12 13:07:51 +00:00
}
enum AttributeInputTypeEnum {
DROPDOWN
MULTISELECT
}
type AttributeReorderValues {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
attribute: Attribute
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
enum AttributeSortField {
NAME
SLUG
VALUE_REQUIRED
IS_VARIANT_ONLY
VISIBLE_IN_STOREFRONT
FILTERABLE_IN_STOREFRONT
FILTERABLE_IN_DASHBOARD
STOREFRONT_SEARCH_POSITION
AVAILABLE_IN_GRID
}
input AttributeSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: AttributeSortField!
2019-08-12 13:07:51 +00:00
}
2019-11-27 10:00:36 +00:00
type AttributeTranslatableContent implements Node {
id: ID!
name: String!
translation(languageCode: LanguageCodeEnum!): AttributeTranslation
attribute: Attribute
}
2019-08-12 13:07:51 +00:00
type AttributeTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
attribute: Attribute
}
type AttributeTranslation implements Node {
id: ID!
name: String!
language: LanguageDisplay!
}
enum AttributeTypeEnum {
PRODUCT
VARIANT
}
type AttributeUnassign {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
productType: ProductType
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type AttributeUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
attribute: Attribute
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
input AttributeUpdateInput {
name: String
slug: String
removeValues: [ID]
addValues: [AttributeValueCreateInput]
valueRequired: Boolean
isVariantOnly: Boolean
visibleInStorefront: Boolean
filterableInStorefront: Boolean
filterableInDashboard: Boolean
storefrontSearchPosition: Int
availableInGrid: Boolean
}
type AttributeUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attribute: Attribute
}
type AttributeUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attribute: Attribute
}
type AttributeValue implements Node {
id: ID!
name: String
slug: String
2020-06-10 13:39:10 +00:00
type: AttributeValueType @deprecated(reason: "Use the `inputType` field to determine the type of attribute's value. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
translation(languageCode: LanguageCodeEnum!): AttributeValueTranslation
inputType: AttributeInputTypeEnum
}
type AttributeValueBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type AttributeValueCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
attribute: Attribute
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attributeValue: AttributeValue
}
input AttributeValueCreateInput {
name: String!
}
type AttributeValueDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
attribute: Attribute
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attributeValue: AttributeValue
}
input AttributeValueInput {
id: ID
values: [String]!
}
2019-11-27 10:00:36 +00:00
type AttributeValueTranslatableContent implements Node {
id: ID!
name: String!
translation(languageCode: LanguageCodeEnum!): AttributeValueTranslation
attributeValue: AttributeValue
}
2019-08-12 13:07:51 +00:00
type AttributeValueTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
attributeValue: AttributeValue
}
type AttributeValueTranslation implements Node {
id: ID!
name: String!
language: LanguageDisplay!
}
enum AttributeValueType {
COLOR
GRADIENT
URL
STRING
}
type AttributeValueUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
attribute: Attribute
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
attributeValue: AttributeValue
}
type AuthorizationKey {
name: AuthorizationKeyType!
key: String!
}
type AuthorizationKeyAdd {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
authorizationKey: AuthorizationKey
shop: Shop
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2019-08-12 13:07:51 +00:00
}
type AuthorizationKeyDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
authorizationKey: AuthorizationKey
shop: Shop
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2019-08-12 13:07:51 +00:00
}
input AuthorizationKeyInput {
key: String!
password: String!
}
enum AuthorizationKeyType {
FACEBOOK
GOOGLE_OAUTH2
}
2019-09-26 15:06:14 +00:00
type BulkProductError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: ProductErrorCode!
2019-09-26 15:06:14 +00:00
index: Int
2020-04-22 14:41:07 +00:00
warehouses: [ID!]
2019-09-26 15:06:14 +00:00
}
2020-03-09 14:59:58 +00:00
type BulkStockError {
field: String
message: String
code: ProductErrorCode!
index: Int
}
2019-08-12 13:07:51 +00:00
input CatalogueInput {
products: [ID]
categories: [ID]
collections: [ID]
}
2020-03-03 11:20:39 +00:00
type Category implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
seoTitle: String
seoDescription: String
id: ID!
name: String!
description: String!
descriptionJson: JSONString!
2019-11-27 10:00:36 +00:00
slug: String!
2019-08-12 13:07:51 +00:00
parent: Category
level: Int!
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
ancestors(before: String, after: String, first: Int, last: Int): CategoryCountableConnection
products(before: String, after: String, first: Int, last: Int): ProductCountableConnection
url: String @deprecated(reason: "This field will be removed after 2020-07-31.")
children(before: String, after: String, first: Int, last: Int): CategoryCountableConnection
2019-08-12 13:07:51 +00:00
backgroundImage(size: Int): Image
translation(languageCode: LanguageCodeEnum!): CategoryTranslation
}
type CategoryBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type CategoryClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
type CategoryClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
type CategoryCountableConnection {
pageInfo: PageInfo!
edges: [CategoryCountableEdge!]!
totalCount: Int
}
type CategoryCountableEdge {
node: Category!
cursor: String!
}
type CategoryCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
type CategoryDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
2019-09-10 11:28:18 +00:00
input CategoryFilterInput {
search: String
2020-01-17 15:16:05 +00:00
ids: [ID]
2019-09-10 11:28:18 +00:00
}
2019-08-12 13:07:51 +00:00
input CategoryInput {
description: String
descriptionJson: JSONString
name: String
slug: String
seo: SeoInput
backgroundImage: Upload
backgroundImageAlt: String
}
2019-12-17 17:13:56 +00:00
enum CategorySortField {
NAME
PRODUCT_COUNT
SUBCATEGORY_COUNT
}
input CategorySortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: CategorySortField!
2019-12-17 17:13:56 +00:00
}
2019-11-27 10:00:36 +00:00
type CategoryTranslatableContent implements Node {
seoTitle: String
seoDescription: String
id: ID!
name: String!
description: String!
descriptionJson: JSONString!
translation(languageCode: LanguageCodeEnum!): CategoryTranslation
category: Category
}
2019-08-12 13:07:51 +00:00
type CategoryTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
type CategoryTranslation implements Node {
seoTitle: String
seoDescription: String
id: ID!
name: String!
description: String!
descriptionJson: JSONString!
language: LanguageDisplay!
}
type CategoryUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
type CategoryUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
type CategoryUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
category: Category
}
2020-03-03 11:20:39 +00:00
type Checkout implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
created: DateTime!
lastChange: DateTime!
user: User
quantity: Int!
billingAddress: Address
shippingAddress: Address
shippingMethod: ShippingMethod
note: String!
2019-08-28 14:53:57 +00:00
discount: Money
2019-08-12 13:07:51 +00:00
discountName: String
translatedDiscountName: String
voucherCode: String
giftCards: [GiftCard]
id: ID!
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
availableShippingMethods: [ShippingMethod]!
2020-06-10 13:39:10 +00:00
availablePaymentGateways: [PaymentGateway!]!
2019-08-12 13:07:51 +00:00
email: String!
isShippingRequired: Boolean!
lines: [CheckoutLine]
shippingPrice: TaxedMoney
subtotalPrice: TaxedMoney
2020-06-10 13:39:10 +00:00
token: UUID!
2019-08-12 13:07:51 +00:00
totalPrice: TaxedMoney
}
type CheckoutAddPromoCode {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutBillingAddressUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
2019-10-09 06:56:46 +00:00
type CheckoutClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
checkout: Checkout
}
2019-10-09 06:56:46 +00:00
type CheckoutClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
checkout: Checkout
}
type CheckoutComplete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
confirmationNeeded: Boolean!
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutCountableConnection {
pageInfo: PageInfo!
edges: [CheckoutCountableEdge!]!
totalCount: Int
}
type CheckoutCountableEdge {
node: Checkout!
cursor: String!
}
type CheckoutCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
created: Boolean
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
checkout: Checkout
}
input CheckoutCreateInput {
lines: [CheckoutLineInput]!
email: String
shippingAddress: AddressInput
billingAddress: AddressInput
}
type CheckoutCustomerAttach {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutCustomerDetach {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutEmailUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-09-26 10:14:07 +00:00
}
type CheckoutError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: CheckoutErrorCode!
2019-09-26 10:14:07 +00:00
}
enum CheckoutErrorCode {
BILLING_ADDRESS_NOT_SET
CHECKOUT_NOT_FULLY_PAID
GRAPHQL_ERROR
2020-06-10 13:39:10 +00:00
PRODUCT_NOT_PUBLISHED
2019-09-26 10:14:07 +00:00
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
2019-08-12 13:07:51 +00:00
}
type CheckoutLine implements Node {
id: ID!
variant: ProductVariant!
quantity: Int!
totalPrice: TaxedMoney
requiresShipping: Boolean
}
type CheckoutLineCountableConnection {
pageInfo: PageInfo!
edges: [CheckoutLineCountableEdge!]!
totalCount: Int
}
type CheckoutLineCountableEdge {
node: CheckoutLine!
cursor: String!
}
type CheckoutLineDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
input CheckoutLineInput {
quantity: Int!
variantId: ID!
}
type CheckoutLinesAdd {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutLinesUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutPaymentCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
payment: Payment
2020-03-03 11:20:39 +00:00
paymentErrors: [PaymentError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutRemovePromoCode {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutShippingAddressUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutShippingMethodUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
checkout: Checkout
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
}
type CheckoutUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
checkout: Checkout
}
type CheckoutUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
checkoutErrors: [CheckoutError!]!
2019-08-12 13:07:51 +00:00
checkout: Checkout
}
type ChoiceValue {
raw: String
verbose: String
}
2020-03-03 11:20:39 +00:00
type Collection implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
seoTitle: String
seoDescription: String
id: ID!
name: String!
description: String!
descriptionJson: JSONString!
2019-11-27 10:00:36 +00:00
publicationDate: Date
isPublished: Boolean!
slug: String!
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
products(before: String, after: String, first: Int, last: Int): ProductCountableConnection
2019-08-12 13:07:51 +00:00
backgroundImage(size: Int): Image
translation(languageCode: LanguageCodeEnum!): CollectionTranslation
}
type CollectionAddProducts {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
collection: Collection
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type CollectionBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type CollectionBulkPublish {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type CollectionClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
type CollectionClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
type CollectionCountableConnection {
pageInfo: PageInfo!
edges: [CollectionCountableEdge!]!
totalCount: Int
}
type CollectionCountableEdge {
node: Collection!
cursor: String!
}
type CollectionCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
input CollectionCreateInput {
isPublished: Boolean
name: String
slug: String
description: String
descriptionJson: JSONString
backgroundImage: Upload
backgroundImageAlt: String
seo: SeoInput
publicationDate: Date
products: [ID]
}
type CollectionDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
input CollectionFilterInput {
published: CollectionPublished
search: String
2020-01-17 15:16:05 +00:00
ids: [ID]
2019-08-12 13:07:51 +00:00
}
input CollectionInput {
isPublished: Boolean
name: String
slug: String
description: String
descriptionJson: JSONString
backgroundImage: Upload
backgroundImageAlt: String
seo: SeoInput
publicationDate: Date
}
enum CollectionPublished {
PUBLISHED
HIDDEN
}
type CollectionRemoveProducts {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
collection: Collection
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type CollectionReorderProducts {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
collection: Collection
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
2019-12-17 17:13:56 +00:00
enum CollectionSortField {
NAME
AVAILABILITY
PRODUCT_COUNT
}
input CollectionSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: CollectionSortField!
2019-12-17 17:13:56 +00:00
}
2019-11-27 10:00:36 +00:00
type CollectionTranslatableContent implements Node {
seoTitle: String
seoDescription: String
id: ID!
name: String!
description: String!
descriptionJson: JSONString!
translation(languageCode: LanguageCodeEnum!): CollectionTranslation
collection: Collection
}
2019-08-12 13:07:51 +00:00
type CollectionTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
type CollectionTranslation implements Node {
seoTitle: String
seoDescription: String
id: ID!
name: String!
description: String!
descriptionJson: JSONString!
language: LanguageDisplay!
}
type CollectionUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
type CollectionUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
type CollectionUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
collection: Collection
}
type ConfigurationItem {
name: String!
2019-11-07 12:07:12 +00:00
value: String
2019-08-12 13:07:51 +00:00
type: ConfigurationTypeFieldEnum
helpText: String
label: String
}
input ConfigurationItemInput {
name: String!
2019-11-27 10:00:36 +00:00
value: String
2019-08-12 13:07:51 +00:00
}
enum ConfigurationTypeFieldEnum {
STRING
BOOLEAN
2019-11-07 12:07:12 +00:00
SECRET
PASSWORD
2019-08-12 13:07:51 +00:00
}
2020-01-17 15:16:05 +00:00
type ConfirmAccount {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
user: User
accountErrors: [AccountError!]!
2020-01-17 15:16:05 +00:00
}
type ConfirmEmailChange {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-01-17 15:16:05 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2020-01-17 15:16:05 +00:00
}
2019-08-12 13:07:51 +00:00
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
2019-08-28 14:53:57 +00:00
MK
2019-08-12 13:07:51 +00:00
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
}
type CountryDisplay {
code: String!
country: String!
vat: VAT
}
type CreateToken {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-07-01 11:11:08 +00:00
token: String
refreshToken: String
csrfToken: String
2019-08-12 13:07:51 +00:00
user: User
2020-07-01 11:11:08 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type CreditCard {
brand: String!
firstDigits: String!
lastDigits: String!
expMonth: Int!
expYear: Int!
}
type CustomerBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type CustomerCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
type CustomerDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
type CustomerEvent implements Node {
id: ID!
date: DateTime
type: CustomerEventsEnum
2020-03-03 11:20:39 +00:00
user: User
2019-08-12 13:07:51 +00:00
message: String
count: Int
order: Order
orderLine: OrderLine
}
enum CustomerEventsEnum {
ACCOUNT_CREATED
PASSWORD_RESET_LINK_SENT
PASSWORD_RESET
2020-01-17 15:16:05 +00:00
EMAIL_CHANGED_REQUEST
PASSWORD_CHANGED
EMAIL_CHANGED
2019-08-12 13:07:51 +00:00
PLACED_ORDER
NOTE_ADDED_TO_ORDER
DIGITAL_LINK_DOWNLOADED
CUSTOMER_DELETED
NAME_ASSIGNED
EMAIL_ASSIGNED
NOTE_ADDED
}
input CustomerFilterInput {
dateJoined: DateRangeInput
moneySpent: PriceRangeInput
numberOfOrders: IntRangeInput
placedOrders: DateRangeInput
search: String
}
input CustomerInput {
defaultBillingAddress: AddressInput
defaultShippingAddress: AddressInput
firstName: String
lastName: String
email: String
isActive: Boolean
note: String
}
type CustomerUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
scalar Date
input DateRangeInput {
gte: Date
lte: Date
}
scalar DateTime
input DateTimeRangeInput {
gte: DateTime
lte: DateTime
}
2020-07-01 11:11:08 +00:00
type DeactivateAllUserTokens {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
accountErrors: [AccountError!]!
}
2019-08-12 13:07:51 +00:00
scalar Decimal
2020-03-03 11:20:39 +00:00
type DeleteMetadata {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
type DeletePrivateMetadata {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
type DigitalContent implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
useDefaultSettings: Boolean!
automaticFulfillment: Boolean!
productVariant: ProductVariant!
contentFile: String!
maxDownloads: Int
urlValidDays: Int
urls: [DigitalContentUrl]
id: ID!
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
}
type DigitalContentCountableConnection {
pageInfo: PageInfo!
edges: [DigitalContentCountableEdge!]!
totalCount: Int
}
type DigitalContentCountableEdge {
node: DigitalContent!
cursor: String!
}
type DigitalContentCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
variant: ProductVariant
content: DigitalContent
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type DigitalContentDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
variant: ProductVariant
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
input DigitalContentInput {
useDefaultSettings: Boolean!
maxDownloads: Int
urlValidDays: Int
automaticFulfillment: Boolean
}
type DigitalContentUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
variant: ProductVariant
content: DigitalContent
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
input DigitalContentUploadInput {
useDefaultSettings: Boolean!
maxDownloads: Int
urlValidDays: Int
automaticFulfillment: Boolean
contentFile: Upload!
}
type DigitalContentUrl implements Node {
content: DigitalContent!
created: DateTime!
downloadNum: Int!
id: ID!
url: String
2020-06-10 13:39:10 +00:00
token: UUID!
2019-08-12 13:07:51 +00:00
}
type DigitalContentUrlCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
digitalContentUrl: DigitalContentUrl
}
input DigitalContentUrlCreateInput {
content: ID!
}
2020-03-23 17:59:10 +00:00
type DiscountError {
field: String
message: String
code: DiscountErrorCode!
}
enum DiscountErrorCode {
ALREADY_EXISTS
2020-04-20 11:11:07 +00:00
GRAPHQL_ERROR
2020-03-23 17:59:10 +00:00
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
2019-08-12 13:07:51 +00:00
enum DiscountStatusEnum {
ACTIVE
EXPIRED
SCHEDULED
}
enum DiscountValueTypeEnum {
FIXED
PERCENTAGE
}
type Domain {
host: String!
sslEnabled: Boolean!
url: String!
}
type DraftOrderBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type DraftOrderComplete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type DraftOrderCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
order: Order
}
input DraftOrderCreateInput {
billingAddress: AddressInput
user: ID
userEmail: String
discount: Decimal
shippingAddress: AddressInput
shippingMethod: ID
voucher: ID
2019-11-27 10:00:36 +00:00
customerNote: String
2019-08-12 13:07:51 +00:00
lines: [OrderLineCreateInput]
}
type DraftOrderDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
order: Order
}
input DraftOrderInput {
billingAddress: AddressInput
user: ID
userEmail: String
discount: Decimal
shippingAddress: AddressInput
shippingMethod: ID
voucher: ID
2019-11-27 10:00:36 +00:00
customerNote: String
2019-08-12 13:07:51 +00:00
}
type DraftOrderLineDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
orderLine: OrderLine
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type DraftOrderLineUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
orderLine: OrderLine
}
type DraftOrderLinesBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type DraftOrderLinesCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
orderLines: [OrderLine!]
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type DraftOrderUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
order: Order
}
type Error {
field: String
message: String
}
2020-03-03 11:20:39 +00:00
type Fulfillment implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
id: ID!
fulfillmentOrder: Int!
status: FulfillmentStatus!
trackingNumber: String!
2019-11-27 10:00:36 +00:00
created: DateTime!
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
lines: [FulfillmentLine]
statusDisplay: String
2020-04-22 14:41:07 +00:00
warehouse: Warehouse
2019-08-12 13:07:51 +00:00
}
type FulfillmentCancel {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
fulfillment: Fulfillment
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
input FulfillmentCancelInput {
2020-04-22 14:41:07 +00:00
warehouseId: ID!
2019-08-12 13:07:51 +00:00
}
2019-10-25 12:18:52 +00:00
type FulfillmentClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-25 12:18:52 +00:00
fulfillment: Fulfillment
}
type FulfillmentClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-25 12:18:52 +00:00
fulfillment: Fulfillment
}
2019-08-12 13:07:51 +00:00
type FulfillmentLine implements Node {
id: ID!
quantity: Int!
orderLine: OrderLine
}
enum FulfillmentStatus {
FULFILLED
CANCELED
}
2019-10-25 12:18:52 +00:00
type FulfillmentUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-25 12:18:52 +00:00
fulfillment: Fulfillment
}
type FulfillmentUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-25 12:18:52 +00:00
fulfillment: Fulfillment
}
2019-08-12 13:07:51 +00:00
type FulfillmentUpdateTracking {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
fulfillment: Fulfillment
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
input FulfillmentUpdateTrackingInput {
trackingNumber: String
2020-01-09 11:13:24 +00:00
notifyCustomer: Boolean = false
2019-08-12 13:07:51 +00:00
}
2019-10-09 06:56:46 +00:00
type GatewayConfigLine {
field: String!
value: String
}
2019-08-12 13:07:51 +00:00
scalar GenericScalar
type Geolocalization {
country: CountryDisplay
}
type GiftCard implements Node {
code: String
user: User
created: DateTime!
startDate: Date!
endDate: Date
lastUsedOn: DateTime
isActive: Boolean!
initialBalance: Money
currentBalance: Money
id: ID!
displayCode: String
}
type GiftCardActivate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
giftCard: GiftCard
2020-03-03 11:20:39 +00:00
giftCardErrors: [GiftCardError!]!
2019-08-12 13:07:51 +00:00
}
type GiftCardCountableConnection {
pageInfo: PageInfo!
edges: [GiftCardCountableEdge!]!
totalCount: Int
}
type GiftCardCountableEdge {
node: GiftCard!
cursor: String!
}
type GiftCardCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
giftCardErrors: [GiftCardError!]!
2019-08-12 13:07:51 +00:00
giftCard: GiftCard
}
input GiftCardCreateInput {
startDate: Date
endDate: Date
balance: Decimal
userEmail: String
code: String
}
type GiftCardDeactivate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
giftCard: GiftCard
2020-03-03 11:20:39 +00:00
giftCardErrors: [GiftCardError!]!
2019-09-26 10:14:07 +00:00
}
type GiftCardError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: GiftCardErrorCode!
2019-09-26 10:14:07 +00:00
}
enum GiftCardErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
2019-08-12 13:07:51 +00:00
}
type GiftCardUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
giftCardErrors: [GiftCardError!]!
2019-08-12 13:07:51 +00:00
giftCard: GiftCard
}
input GiftCardUpdateInput {
startDate: Date
endDate: Date
balance: Decimal
userEmail: String
}
2020-03-03 11:20:39 +00:00
type Group implements Node {
id: ID!
name: String!
2020-04-20 11:11:07 +00:00
permissions: [Permission]
2020-03-03 11:20:39 +00:00
users: [User]
2020-04-20 11:11:07 +00:00
userCanManage: Boolean!
2020-03-03 11:20:39 +00:00
}
type GroupCountableConnection {
pageInfo: PageInfo!
edges: [GroupCountableEdge!]!
totalCount: Int
}
type GroupCountableEdge {
node: Group!
cursor: String!
}
2019-08-12 13:07:51 +00:00
type HomepageCollectionUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shop: Shop
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2019-08-12 13:07:51 +00:00
}
type Image {
url: String!
alt: String
}
input IntRangeInput {
gte: Int
lte: Int
}
scalar JSONString
enum LanguageCodeEnum {
AR
AZ
BG
BN
CA
CS
DA
DE
EL
EN
ES
ES_CO
ET
FA
2020-06-10 13:39:10 +00:00
FI
2019-08-12 13:07:51 +00:00
FR
HI
HU
HY
ID
IS
IT
JA
KO
LT
MN
NB
NL
PL
PT
PT_BR
RO
RU
SK
2020-06-10 13:39:10 +00:00
SL
2019-08-12 13:07:51 +00:00
SQ
SR
SV
2020-06-10 13:39:10 +00:00
SW
TA
2019-08-12 13:07:51 +00:00
TH
TR
UK
VI
ZH_HANS
ZH_HANT
}
type LanguageDisplay {
code: LanguageCodeEnum!
language: String!
}
type Margin {
start: Int
stop: Int
}
type Menu implements Node {
id: ID!
name: String!
items: [MenuItem]
}
type MenuBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
}
type MenuCountableConnection {
pageInfo: PageInfo!
edges: [MenuCountableEdge!]!
totalCount: Int
}
type MenuCountableEdge {
node: Menu!
cursor: String!
}
type MenuCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
menu: Menu
}
input MenuCreateInput {
name: String!
items: [MenuItemInput]
}
type MenuDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
menu: Menu
}
2019-09-26 10:14:07 +00:00
type MenuError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: MenuErrorCode!
2019-09-26 10:14:07 +00:00
}
enum MenuErrorCode {
CANNOT_ASSIGN_NODE
GRAPHQL_ERROR
INVALID
INVALID_MENU_ITEM
NO_MENU_ITEM_PROVIDED
NOT_FOUND
REQUIRED
TOO_MANY_MENU_ITEMS
UNIQUE
}
2019-09-10 11:28:18 +00:00
input MenuFilterInput {
search: String
}
2019-08-12 13:07:51 +00:00
input MenuInput {
name: String
}
type MenuItem implements Node {
id: ID!
2019-11-27 10:00:36 +00:00
name: String!
2019-08-12 13:07:51 +00:00
menu: Menu!
parent: MenuItem
category: Category
collection: Collection
page: Page
level: Int!
children: [MenuItem]
url: String
translation(languageCode: LanguageCodeEnum!): MenuItemTranslation
}
type MenuItemBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
}
type MenuItemCountableConnection {
pageInfo: PageInfo!
edges: [MenuItemCountableEdge!]!
totalCount: Int
}
type MenuItemCountableEdge {
node: MenuItem!
cursor: String!
}
type MenuItemCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
menuItem: MenuItem
}
input MenuItemCreateInput {
name: String!
url: String
category: ID
collection: ID
page: ID
menu: ID!
parent: ID
}
type MenuItemDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
menuItem: MenuItem
}
2019-09-10 11:28:18 +00:00
input MenuItemFilterInput {
search: String
}
2019-08-12 13:07:51 +00:00
input MenuItemInput {
name: String
url: String
category: ID
collection: ID
page: ID
}
type MenuItemMove {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
menu: Menu
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
}
input MenuItemMoveInput {
itemId: ID!
parentId: ID
sortOrder: Int
}
2019-12-17 17:13:56 +00:00
input MenuItemSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: MenuItemsSortField!
2019-12-17 17:13:56 +00:00
}
2019-11-27 10:00:36 +00:00
type MenuItemTranslatableContent implements Node {
id: ID!
name: String!
translation(languageCode: LanguageCodeEnum!): MenuItemTranslation
menuItem: MenuItem
}
2019-08-12 13:07:51 +00:00
type MenuItemTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
menuItem: MenuItem
}
type MenuItemTranslation implements Node {
id: ID!
name: String!
language: LanguageDisplay!
}
type MenuItemUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
menuItem: MenuItem
}
2019-12-17 17:13:56 +00:00
enum MenuItemsSortField {
NAME
}
enum MenuSortField {
NAME
ITEMS_COUNT
}
input MenuSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: MenuSortField!
2019-12-17 17:13:56 +00:00
}
2019-08-12 13:07:51 +00:00
type MenuUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
menuErrors: [MenuError!]!
2019-08-12 13:07:51 +00:00
menu: Menu
}
type MetaClientStore {
name: String!
metadata: [MetaItem]!
}
input MetaInput {
namespace: String!
clientName: String!
key: String!
value: String!
}
type MetaItem {
key: String!
value: String!
}
input MetaPath {
namespace: String!
clientName: String!
key: String!
}
type MetaStore {
namespace: String!
clients: [MetaClientStore]!
}
2020-03-03 11:20:39 +00:00
type MetadataError {
field: String
message: String
code: MetadataErrorCode!
}
enum MetadataErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
input MetadataInput {
key: String!
value: String!
}
type MetadataItem {
key: String!
value: String!
}
2019-08-12 13:07:51 +00:00
type Money {
currency: String!
amount: Float!
2020-04-22 14:41:07 +00:00
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.")
2019-08-12 13:07:51 +00:00
}
type MoneyRange {
start: Money
stop: Money
}
input MoveProductInput {
productId: ID!
sortOrder: Int
}
2019-10-17 15:29:13 +00:00
type Mutation {
2019-09-26 15:06:14 +00:00
webhookCreate(input: WebhookCreateInput!): WebhookCreate
webhookDelete(id: ID!): WebhookDelete
webhookUpdate(id: ID!, input: WebhookUpdateInput!): WebhookUpdate
2020-01-17 15:16:05 +00:00
createWarehouse(input: WarehouseCreateInput!): WarehouseCreate
updateWarehouse(id: ID!, input: WarehouseUpdateInput!): WarehouseUpdate
deleteWarehouse(id: ID!): WarehouseDelete
2020-04-22 14:41:07 +00:00
assignWarehouseShippingZone(id: ID!, shippingZoneIds: [ID!]!): WarehouseShippingZoneAssign
unassignWarehouseShippingZone(id: ID!, shippingZoneIds: [ID!]!): WarehouseShippingZoneUnassign
authorizationKeyAdd(input: AuthorizationKeyInput!, keyType: AuthorizationKeyType!): AuthorizationKeyAdd
2019-08-12 13:07:51 +00:00
authorizationKeyDelete(keyType: AuthorizationKeyType!): AuthorizationKeyDelete
2020-04-22 14:41:07 +00:00
staffNotificationRecipientCreate(input: StaffNotificationRecipientInput!): StaffNotificationRecipientCreate
staffNotificationRecipientUpdate(id: ID!, input: StaffNotificationRecipientInput!): StaffNotificationRecipientUpdate
2020-01-17 15:16:05 +00:00
staffNotificationRecipientDelete(id: ID!): StaffNotificationRecipientDelete
2019-08-12 13:07:51 +00:00
homepageCollectionUpdate(collection: ID): HomepageCollectionUpdate
shopDomainUpdate(input: SiteDomainInput): ShopDomainUpdate
shopSettingsUpdate(input: ShopSettingsInput!): ShopSettingsUpdate
shopFetchTaxRates: ShopFetchTaxRates
2020-04-22 14:41:07 +00:00
shopSettingsTranslate(input: ShopSettingsTranslationInput!, languageCode: LanguageCodeEnum!): ShopSettingsTranslate
2019-08-12 13:07:51 +00:00
shopAddressUpdate(input: AddressInput): ShopAddressUpdate
shippingPriceCreate(input: ShippingPriceInput!): ShippingPriceCreate
shippingPriceDelete(id: ID!): ShippingPriceDelete
shippingPriceBulkDelete(ids: [ID]!): ShippingPriceBulkDelete
shippingPriceUpdate(id: ID!, input: ShippingPriceInput!): ShippingPriceUpdate
2020-04-22 14:41:07 +00:00
shippingPriceTranslate(id: ID!, input: NameTranslationInput!, languageCode: LanguageCodeEnum!): ShippingPriceTranslate
2020-04-20 11:11:07 +00:00
shippingZoneCreate(input: ShippingZoneCreateInput!): ShippingZoneCreate
2019-08-12 13:07:51 +00:00
shippingZoneDelete(id: ID!): ShippingZoneDelete
shippingZoneBulkDelete(ids: [ID]!): ShippingZoneBulkDelete
2020-04-22 14:41:07 +00:00
shippingZoneUpdate(id: ID!, input: ShippingZoneUpdateInput!): ShippingZoneUpdate
2019-08-12 13:07:51 +00:00
attributeCreate(input: AttributeCreateInput!): AttributeCreate
attributeDelete(id: ID!): AttributeDelete
attributeBulkDelete(ids: [ID]!): AttributeBulkDelete
2020-04-22 14:41:07 +00:00
attributeAssign(operations: [AttributeAssignInput]!, productTypeId: ID!): AttributeAssign
2019-08-12 13:07:51 +00:00
attributeUnassign(attributeIds: [ID]!, productTypeId: ID!): AttributeUnassign
attributeUpdate(id: ID!, input: AttributeUpdateInput!): AttributeUpdate
2020-04-22 14:41:07 +00:00
attributeTranslate(id: ID!, input: NameTranslationInput!, languageCode: LanguageCodeEnum!): AttributeTranslate
attributeUpdateMetadata(id: ID!, input: MetaInput!): AttributeUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
attributeClearMetadata(id: ID!, input: MetaPath!): AttributeClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
attributeUpdatePrivateMetadata(id: ID!, input: MetaInput!): AttributeUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
attributeClearPrivateMetadata(id: ID!, input: MetaPath!): AttributeClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
attributeValueCreate(attribute: ID!, input: AttributeValueCreateInput!): AttributeValueCreate
2019-08-12 13:07:51 +00:00
attributeValueDelete(id: ID!): AttributeValueDelete
attributeValueBulkDelete(ids: [ID]!): AttributeValueBulkDelete
2020-04-22 14:41:07 +00:00
attributeValueUpdate(id: ID!, input: AttributeValueCreateInput!): AttributeValueUpdate
attributeValueTranslate(id: ID!, input: NameTranslationInput!, languageCode: LanguageCodeEnum!): AttributeValueTranslate
attributeReorderValues(attributeId: ID!, moves: [ReorderInput]!): AttributeReorderValues
2019-08-12 13:07:51 +00:00
categoryCreate(input: CategoryInput!, parent: ID): CategoryCreate
categoryDelete(id: ID!): CategoryDelete
categoryBulkDelete(ids: [ID]!): CategoryBulkDelete
categoryUpdate(id: ID!, input: CategoryInput!): CategoryUpdate
2020-04-22 14:41:07 +00:00
categoryTranslate(id: ID!, input: TranslationInput!, languageCode: LanguageCodeEnum!): CategoryTranslate
categoryUpdateMetadata(id: ID!, input: MetaInput!): CategoryUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
categoryClearMetadata(id: ID!, input: MetaPath!): CategoryClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
categoryUpdatePrivateMetadata(id: ID!, input: MetaInput!): CategoryUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
categoryClearPrivateMetadata(id: ID!, input: MetaPath!): CategoryClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
collectionAddProducts(collectionId: ID!, products: [ID]!): CollectionAddProducts
2019-08-12 13:07:51 +00:00
collectionCreate(input: CollectionCreateInput!): CollectionCreate
collectionDelete(id: ID!): CollectionDelete
2020-04-22 14:41:07 +00:00
collectionReorderProducts(collectionId: ID!, moves: [MoveProductInput]!): CollectionReorderProducts
2019-08-12 13:07:51 +00:00
collectionBulkDelete(ids: [ID]!): CollectionBulkDelete
2020-04-22 14:41:07 +00:00
collectionBulkPublish(ids: [ID]!, isPublished: Boolean!): CollectionBulkPublish
collectionRemoveProducts(collectionId: ID!, products: [ID]!): CollectionRemoveProducts
2019-08-12 13:07:51 +00:00
collectionUpdate(id: ID!, input: CollectionInput!): CollectionUpdate
2020-04-22 14:41:07 +00:00
collectionTranslate(id: ID!, input: TranslationInput!, languageCode: LanguageCodeEnum!): CollectionTranslate
collectionUpdateMetadata(id: ID!, input: MetaInput!): CollectionUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
collectionClearMetadata(id: ID!, input: MetaPath!): CollectionClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
collectionUpdatePrivateMetadata(id: ID!, input: MetaInput!): CollectionUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
collectionClearPrivateMetadata(id: ID!, input: MetaPath!): CollectionClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
productCreate(input: ProductCreateInput!): ProductCreate
productDelete(id: ID!): ProductDelete
productBulkDelete(ids: [ID]!): ProductBulkDelete
productBulkPublish(ids: [ID]!, isPublished: Boolean!): ProductBulkPublish
productUpdate(id: ID!, input: ProductInput!): ProductUpdate
2020-04-22 14:41:07 +00:00
productTranslate(id: ID!, input: TranslationInput!, languageCode: LanguageCodeEnum!): ProductTranslate
productUpdateMetadata(id: ID!, input: MetaInput!): ProductUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
productClearMetadata(id: ID!, input: MetaPath!): ProductClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
productUpdatePrivateMetadata(id: ID!, input: MetaInput!): ProductUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
productClearPrivateMetadata(id: ID!, input: MetaPath!): ProductClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
productImageCreate(input: ProductImageCreateInput!): ProductImageCreate
productImageDelete(id: ID!): ProductImageDelete
productImageBulkDelete(ids: [ID]!): ProductImageBulkDelete
productImageReorder(imagesIds: [ID]!, productId: ID!): ProductImageReorder
2020-04-22 14:41:07 +00:00
productImageUpdate(id: ID!, input: ProductImageUpdateInput!): ProductImageUpdate
2019-08-12 13:07:51 +00:00
productTypeCreate(input: ProductTypeInput!): ProductTypeCreate
productTypeDelete(id: ID!): ProductTypeDelete
productTypeBulkDelete(ids: [ID]!): ProductTypeBulkDelete
productTypeUpdate(id: ID!, input: ProductTypeInput!): ProductTypeUpdate
2020-04-22 14:41:07 +00:00
productTypeReorderAttributes(moves: [ReorderInput]!, productTypeId: ID!, type: AttributeTypeEnum!): ProductTypeReorderAttributes
productTypeUpdateMetadata(id: ID!, input: MetaInput!): ProductTypeUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
productTypeClearMetadata(id: ID!, input: MetaPath!): ProductTypeClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
productTypeUpdatePrivateMetadata(id: ID!, input: MetaInput!): ProductTypeUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
productTypeClearPrivateMetadata(id: ID!, input: MetaPath!): ProductTypeClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
digitalContentCreate(input: DigitalContentUploadInput!, variantId: ID!): DigitalContentCreate
2019-08-12 13:07:51 +00:00
digitalContentDelete(variantId: ID!): DigitalContentDelete
2020-04-22 14:41:07 +00:00
digitalContentUpdate(input: DigitalContentInput!, variantId: ID!): DigitalContentUpdate
digitalContentUrlCreate(input: DigitalContentUrlCreateInput!): DigitalContentUrlCreate
2019-08-12 13:07:51 +00:00
productVariantCreate(input: ProductVariantCreateInput!): ProductVariantCreate
productVariantDelete(id: ID!): ProductVariantDelete
2020-04-22 14:41:07 +00:00
productVariantBulkCreate(product: ID!, variants: [ProductVariantBulkCreateInput]!): ProductVariantBulkCreate
2019-08-12 13:07:51 +00:00
productVariantBulkDelete(ids: [ID]!): ProductVariantBulkDelete
2020-04-22 14:41:07 +00:00
productVariantStocksCreate(stocks: [StockInput!]!, variantId: ID!): ProductVariantStocksCreate
productVariantStocksDelete(variantId: ID!, warehouseIds: [ID!]): ProductVariantStocksDelete
productVariantStocksUpdate(stocks: [StockInput!]!, variantId: ID!): ProductVariantStocksUpdate
productVariantUpdate(id: ID!, input: ProductVariantInput!): ProductVariantUpdate
productVariantTranslate(id: ID!, input: NameTranslationInput!, languageCode: LanguageCodeEnum!): ProductVariantTranslate
productVariantUpdateMetadata(id: ID!, input: MetaInput!): ProductVariantUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
productVariantClearMetadata(id: ID!, input: MetaPath!): ProductVariantClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
productVariantUpdatePrivateMetadata(id: ID!, input: MetaInput!): ProductVariantUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
productVariantClearPrivateMetadata(id: ID!, input: MetaPath!): ProductVariantClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
variantImageAssign(imageId: ID!, variantId: ID!): VariantImageAssign
variantImageUnassign(imageId: ID!, variantId: ID!): VariantImageUnassign
paymentCapture(amount: Decimal, paymentId: ID!): PaymentCapture
paymentRefund(amount: Decimal, paymentId: ID!): PaymentRefund
paymentVoid(paymentId: ID!): PaymentVoid
2019-08-28 14:53:57 +00:00
paymentSecureConfirm(paymentId: ID!): PaymentSecureConfirm
2019-08-12 13:07:51 +00:00
pageCreate(input: PageInput!): PageCreate
pageDelete(id: ID!): PageDelete
pageBulkDelete(ids: [ID]!): PageBulkDelete
pageBulkPublish(ids: [ID]!, isPublished: Boolean!): PageBulkPublish
pageUpdate(id: ID!, input: PageInput!): PageUpdate
2020-04-22 14:41:07 +00:00
pageTranslate(id: ID!, input: PageTranslationInput!, languageCode: LanguageCodeEnum!): PageTranslate
2019-08-12 13:07:51 +00:00
draftOrderComplete(id: ID!): DraftOrderComplete
draftOrderCreate(input: DraftOrderCreateInput!): DraftOrderCreate
draftOrderDelete(id: ID!): DraftOrderDelete
draftOrderBulkDelete(ids: [ID]!): DraftOrderBulkDelete
draftOrderLinesBulkDelete(ids: [ID]!): DraftOrderLinesBulkDelete
2020-04-22 14:41:07 +00:00
draftOrderLinesCreate(id: ID!, input: [OrderLineCreateInput]!): DraftOrderLinesCreate
2019-08-12 13:07:51 +00:00
draftOrderLineDelete(id: ID!): DraftOrderLineDelete
draftOrderLineUpdate(id: ID!, input: OrderLineInput!): DraftOrderLineUpdate
draftOrderUpdate(id: ID!, input: DraftOrderInput!): DraftOrderUpdate
orderAddNote(order: ID!, input: OrderAddNoteInput!): OrderAddNote
2020-04-22 14:41:07 +00:00
orderCancel(id: ID!): OrderCancel
2019-08-12 13:07:51 +00:00
orderCapture(amount: Decimal!, id: ID!): OrderCapture
2020-04-22 14:41:07 +00:00
orderClearPrivateMeta(id: ID!, input: MetaPath!): OrderClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
orderClearMeta(input: MetaPath!, token: UUID!): OrderClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
orderFulfill(input: OrderFulfillInput!, order: ID): OrderFulfill
orderFulfillmentCancel(id: ID!, input: FulfillmentCancelInput!): FulfillmentCancel
orderFulfillmentUpdateTracking(id: ID!, input: FulfillmentUpdateTrackingInput!): FulfillmentUpdateTracking
orderFulfillmentClearMeta(id: ID!, input: MetaPath!): FulfillmentClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation instead. This field will be removed after 2020-07-31.")
orderFulfillmentClearPrivateMeta(id: ID!, input: MetaPath!): FulfillmentClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
orderFulfillmentUpdateMeta(id: ID!, input: MetaInput!): FulfillmentUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
orderFulfillmentUpdatePrivateMeta(id: ID!, input: MetaInput!): FulfillmentUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
orderMarkAsPaid(id: ID!): OrderMarkAsPaid
orderRefund(amount: Decimal!, id: ID!): OrderRefund
orderUpdate(id: ID!, input: OrderUpdateInput!): OrderUpdate
2020-04-22 14:41:07 +00:00
orderUpdateMeta(input: MetaInput!, token: UUID!): OrderUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation instead. This field will be removed after 2020-07-31.")
orderUpdatePrivateMeta(id: ID!, input: MetaInput!): OrderUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation instead. This field will be removed after 2020-07-31.")
orderUpdateShipping(order: ID!, input: OrderUpdateShippingInput): OrderUpdateShipping
2019-08-12 13:07:51 +00:00
orderVoid(id: ID!): OrderVoid
2020-04-22 14:41:07 +00:00
orderBulkCancel(ids: [ID]!): OrderBulkCancel
2020-04-20 11:11:07 +00:00
deleteMetadata(id: ID!, keys: [String!]!): DeleteMetadata
deletePrivateMetadata(id: ID!, keys: [String!]!): DeletePrivateMetadata
updateMetadata(id: ID!, input: [MetadataInput!]!): UpdateMetadata
2020-04-22 14:41:07 +00:00
updatePrivateMetadata(id: ID!, input: [MetadataInput!]!): UpdatePrivateMetadata
2019-08-12 13:07:51 +00:00
assignNavigation(menu: ID, navigationType: NavigationType!): AssignNavigation
menuCreate(input: MenuCreateInput!): MenuCreate
menuDelete(id: ID!): MenuDelete
menuBulkDelete(ids: [ID]!): MenuBulkDelete
menuUpdate(id: ID!, input: MenuInput!): MenuUpdate
menuItemCreate(input: MenuItemCreateInput!): MenuItemCreate
menuItemDelete(id: ID!): MenuItemDelete
menuItemBulkDelete(ids: [ID]!): MenuItemBulkDelete
menuItemUpdate(id: ID!, input: MenuItemInput!): MenuItemUpdate
2020-04-22 14:41:07 +00:00
menuItemTranslate(id: ID!, input: NameTranslationInput!, languageCode: LanguageCodeEnum!): MenuItemTranslate
2019-08-12 13:07:51 +00:00
menuItemMove(menu: ID!, moves: [MenuItemMoveInput]!): MenuItemMove
giftCardActivate(id: ID!): GiftCardActivate
giftCardCreate(input: GiftCardCreateInput!): GiftCardCreate
giftCardDeactivate(id: ID!): GiftCardDeactivate
giftCardUpdate(id: ID!, input: GiftCardUpdateInput!): GiftCardUpdate
2019-08-28 14:53:57 +00:00
pluginUpdate(id: ID!, input: PluginUpdateInput!): PluginUpdate
2019-08-12 13:07:51 +00:00
saleCreate(input: SaleInput!): SaleCreate
saleDelete(id: ID!): SaleDelete
saleBulkDelete(ids: [ID]!): SaleBulkDelete
saleUpdate(id: ID!, input: SaleInput!): SaleUpdate
saleCataloguesAdd(id: ID!, input: CatalogueInput!): SaleAddCatalogues
saleCataloguesRemove(id: ID!, input: CatalogueInput!): SaleRemoveCatalogues
2020-04-22 14:41:07 +00:00
saleTranslate(id: ID!, input: NameTranslationInput!, languageCode: LanguageCodeEnum!): SaleTranslate
2019-08-12 13:07:51 +00:00
voucherCreate(input: VoucherInput!): VoucherCreate
voucherDelete(id: ID!): VoucherDelete
voucherBulkDelete(ids: [ID]!): VoucherBulkDelete
voucherUpdate(id: ID!, input: VoucherInput!): VoucherUpdate
voucherCataloguesAdd(id: ID!, input: CatalogueInput!): VoucherAddCatalogues
2020-04-22 14:41:07 +00:00
voucherCataloguesRemove(id: ID!, input: CatalogueInput!): VoucherRemoveCatalogues
voucherTranslate(id: ID!, input: NameTranslationInput!, languageCode: LanguageCodeEnum!): VoucherTranslate
checkoutAddPromoCode(checkoutId: ID!, promoCode: String!): CheckoutAddPromoCode
checkoutBillingAddressUpdate(billingAddress: AddressInput!, checkoutId: ID!): CheckoutBillingAddressUpdate
checkoutComplete(checkoutId: ID!, redirectUrl: String, storeSource: Boolean = false): CheckoutComplete
2019-08-12 13:07:51 +00:00
checkoutCreate(input: CheckoutCreateInput!): CheckoutCreate
2020-04-22 14:41:07 +00:00
checkoutCustomerAttach(checkoutId: ID!, customerId: ID): CheckoutCustomerAttach
2019-08-12 13:07:51 +00:00
checkoutCustomerDetach(checkoutId: ID!): CheckoutCustomerDetach
checkoutEmailUpdate(checkoutId: ID, email: String!): CheckoutEmailUpdate
checkoutLineDelete(checkoutId: ID!, lineId: ID): CheckoutLineDelete
2020-04-22 14:41:07 +00:00
checkoutLinesAdd(checkoutId: ID!, lines: [CheckoutLineInput]!): CheckoutLinesAdd
checkoutLinesUpdate(checkoutId: ID!, lines: [CheckoutLineInput]!): CheckoutLinesUpdate
checkoutRemovePromoCode(checkoutId: ID!, promoCode: String!): CheckoutRemovePromoCode
checkoutPaymentCreate(checkoutId: ID!, input: PaymentInput!): CheckoutPaymentCreate
checkoutShippingAddressUpdate(checkoutId: ID!, shippingAddress: AddressInput!): CheckoutShippingAddressUpdate
checkoutShippingMethodUpdate(checkoutId: ID, shippingMethodId: ID!): CheckoutShippingMethodUpdate
checkoutUpdateMetadata(id: ID!, input: MetaInput!): CheckoutUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation. This field will be removed after 2020-07-31.")
checkoutClearMetadata(id: ID!, input: MetaPath!): CheckoutClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation. This field will be removed after 2020-07-31.")
checkoutUpdatePrivateMetadata(id: ID!, input: MetaInput!): CheckoutUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation. This field will be removed after 2020-07-31.")
checkoutClearPrivateMetadata(id: ID!, input: MetaPath!): CheckoutClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation. This field will be removed after 2020-07-31.")
appCreate(input: AppInput!): AppCreate
appUpdate(id: ID!, input: AppInput!): AppUpdate
appDelete(id: ID!): AppDelete
appTokenCreate(input: AppTokenInput!): AppTokenCreate
appTokenDelete(id: ID!): AppTokenDelete
2020-06-10 13:39:10 +00:00
appTokenVerify(token: String!): AppTokenVerify
2020-07-01 11:11:08 +00:00
tokenCreate(email: String!, password: String!): CreateToken
tokenRefresh(csrfToken: String, refreshToken: String): RefreshToken
tokenVerify(token: String!): VerifyToken
tokensDeactivateAll: DeactivateAllUserTokens
2020-04-22 14:41:07 +00:00
requestPasswordReset(email: String!, redirectUrl: String!): RequestPasswordReset
2020-01-17 15:16:05 +00:00
confirmAccount(email: String!, token: String!): ConfirmAccount
2020-07-01 11:11:08 +00:00
setPassword(email: String!, password: String!, token: String!): SetPassword
2019-08-28 14:53:57 +00:00
passwordChange(newPassword: String!, oldPassword: String!): PasswordChange
2020-04-22 14:41:07 +00:00
requestEmailChange(newEmail: String!, password: String!, redirectUrl: String!): RequestEmailChange
2020-01-17 15:16:05 +00:00
confirmEmailChange(token: String!): ConfirmEmailChange
2020-04-22 14:41:07 +00:00
accountAddressCreate(input: AddressInput!, type: AddressTypeEnum): AccountAddressCreate
2019-08-12 13:07:51 +00:00
accountAddressUpdate(id: ID!, input: AddressInput!): AccountAddressUpdate
accountAddressDelete(id: ID!): AccountAddressDelete
2020-04-22 14:41:07 +00:00
accountSetDefaultAddress(id: ID!, type: AddressTypeEnum!): AccountSetDefaultAddress
2019-08-12 13:07:51 +00:00
accountRegister(input: AccountRegisterInput!): AccountRegister
accountUpdate(input: AccountInput!): AccountUpdate
2019-08-28 14:53:57 +00:00
accountRequestDeletion(redirectUrl: String!): AccountRequestDeletion
2019-08-12 13:07:51 +00:00
accountDelete(token: String!): AccountDelete
2020-04-22 14:41:07 +00:00
accountUpdateMeta(input: MetaInput!): AccountUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
addressCreate(input: AddressInput!, userId: ID!): AddressCreate
addressUpdate(id: ID!, input: AddressInput!): AddressUpdate
addressDelete(id: ID!): AddressDelete
2020-04-22 14:41:07 +00:00
addressSetDefault(addressId: ID!, type: AddressTypeEnum!, userId: ID!): AddressSetDefault
2019-08-12 13:07:51 +00:00
customerCreate(input: UserCreateInput!): CustomerCreate
customerUpdate(id: ID!, input: CustomerInput!): CustomerUpdate
customerDelete(id: ID!): CustomerDelete
customerBulkDelete(ids: [ID]!): CustomerBulkDelete
staffCreate(input: StaffCreateInput!): StaffCreate
2020-04-20 11:11:07 +00:00
staffUpdate(id: ID!, input: StaffUpdateInput!): StaffUpdate
2019-08-12 13:07:51 +00:00
staffDelete(id: ID!): StaffDelete
staffBulkDelete(ids: [ID]!): StaffBulkDelete
userAvatarUpdate(image: Upload!): UserAvatarUpdate
userAvatarDelete: UserAvatarDelete
userBulkSetActive(ids: [ID]!, isActive: Boolean!): UserBulkSetActive
2020-04-22 14:41:07 +00:00
userUpdateMetadata(id: ID!, input: MetaInput!): UserUpdateMeta @deprecated(reason: "Use the `updateMetadata` mutation. This field will be removed after 2020-07-31.")
userClearMetadata(id: ID!, input: MetaPath!): UserClearMeta @deprecated(reason: "Use the `deleteMetadata` mutation. This field will be removed after 2020-07-31.")
userUpdatePrivateMetadata(id: ID!, input: MetaInput!): UserUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation. This field will be removed after 2020-07-31.")
userClearPrivateMetadata(id: ID!, input: MetaPath!): UserClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation. This field will be removed after 2020-07-31.")
serviceAccountCreate(input: ServiceAccountInput!): ServiceAccountCreate @deprecated(reason: "Use the `appCreate` mutation instead. This field will be removed after 2020-07-31.")
serviceAccountUpdate(id: ID!, input: ServiceAccountInput!): ServiceAccountUpdate @deprecated(reason: "Use the `appUpdate` mutation instead. This field will be removed after 2020-07-31.")
serviceAccountDelete(id: ID!): ServiceAccountDelete @deprecated(reason: "Use the `appDelete` mutation instead. This field will be removed after 2020-07-31.")
serviceAccountUpdatePrivateMetadata(id: ID!, input: MetaInput!): ServiceAccountUpdatePrivateMeta @deprecated(reason: "Use the `updatePrivateMetadata` mutation with App instead.This field will be removed after 2020-07-31.")
serviceAccountClearPrivateMetadata(id: ID!, input: MetaPath!): ServiceAccountClearPrivateMeta @deprecated(reason: "Use the `deletePrivateMetadata` mutation with App instead.This field will be removed after 2020-07-31.")
serviceAccountTokenCreate(input: ServiceAccountTokenInput!): ServiceAccountTokenCreate @deprecated(reason: "Use the `appTokenCreate` mutation instead. This field will be removed after 2020-07-31.")
serviceAccountTokenDelete(id: ID!): ServiceAccountTokenDelete @deprecated(reason: "Use the `appTokenDelete` mutation instead. This field will be removed after 2020-07-31.")
permissionGroupCreate(input: PermissionGroupCreateInput!): PermissionGroupCreate
permissionGroupUpdate(id: ID!, input: PermissionGroupUpdateInput!): PermissionGroupUpdate
2020-03-03 11:20:39 +00:00
permissionGroupDelete(id: ID!): PermissionGroupDelete
2019-08-12 13:07:51 +00:00
}
input NameTranslationInput {
name: String
}
type Navigation {
main: Menu
secondary: Menu
}
enum NavigationType {
MAIN
SECONDARY
}
interface Node {
id: ID!
}
2020-03-03 11:20:39 +00:00
interface ObjectWithMetadata {
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
}
type Order implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
id: ID!
created: DateTime!
status: OrderStatus!
user: User
languageCode: String!
trackingClientId: String!
billingAddress: Address
shippingAddress: Address
shippingMethod: ShippingMethod
shippingMethodName: String
2019-08-28 14:53:57 +00:00
shippingPrice: TaxedMoney
2019-08-12 13:07:51 +00:00
token: String!
voucher: Voucher
giftCards: [GiftCard]
2019-08-28 14:53:57 +00:00
discount: Money
2020-03-09 14:59:58 +00:00
discountName: String
translatedDiscountName: String
2019-08-12 13:07:51 +00:00
displayGrossPrices: Boolean!
customerNote: String!
weight: Weight
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
fulfillments: [Fulfillment]!
lines: [OrderLine]!
actions: [OrderAction]!
availableShippingMethods: [ShippingMethod]
number: String
isPaid: Boolean
paymentStatus: PaymentChargeStatusEnum
paymentStatusDisplay: String
payments: [Payment]
total: TaxedMoney
subtotal: TaxedMoney
statusDisplay: String
canFinalize: Boolean!
totalAuthorized: Money
totalCaptured: Money
events: [OrderEvent]
totalBalance: Money!
userEmail: String
isShippingRequired: Boolean!
}
enum OrderAction {
CAPTURE
MARK_AS_PAID
REFUND
VOID
}
type OrderAddNote {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
event: OrderEvent
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
input OrderAddNoteInput {
2020-03-09 14:59:58 +00:00
message: String!
2019-08-12 13:07:51 +00:00
}
type OrderBulkCancel {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type OrderCancel {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type OrderCapture {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
2019-10-09 06:56:46 +00:00
type OrderClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-09 06:56:46 +00:00
order: Order
}
type OrderClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-09 06:56:46 +00:00
order: Order
}
2019-08-12 13:07:51 +00:00
type OrderCountableConnection {
pageInfo: PageInfo!
edges: [OrderCountableEdge!]!
totalCount: Int
}
type OrderCountableEdge {
node: Order!
cursor: String!
}
enum OrderDirection {
ASC
DESC
}
input OrderDraftFilterInput {
customer: String
created: DateRangeInput
2019-09-10 11:28:18 +00:00
search: String
2019-08-12 13:07:51 +00:00
}
2019-09-26 10:14:07 +00:00
type OrderError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: OrderErrorCode!
2020-04-22 14:41:07 +00:00
warehouse: ID
orderLine: ID
2019-09-26 10:14:07 +00:00
}
enum OrderErrorCode {
2020-03-03 11:20:39 +00:00
BILLING_ADDRESS_NOT_SET
2019-09-26 10:14:07 +00:00
CANNOT_CANCEL_FULFILLMENT
CANNOT_CANCEL_ORDER
CANNOT_DELETE
CANNOT_REFUND
CAPTURE_INACTIVE_PAYMENT
NOT_EDITABLE
FULFILL_ORDER_LINE
GRAPHQL_ERROR
INVALID
2020-06-10 13:39:10 +00:00
PRODUCT_NOT_PUBLISHED
2019-09-26 10:14:07 +00:00
NOT_FOUND
ORDER_NO_SHIPPING_ADDRESS
PAYMENT_ERROR
PAYMENT_MISSING
REQUIRED
SHIPPING_METHOD_NOT_APPLICABLE
SHIPPING_METHOD_REQUIRED
UNIQUE
VOID_INACTIVE_PAYMENT
ZERO_QUANTITY
INSUFFICIENT_STOCK
2020-04-22 14:41:07 +00:00
DUPLICATED_INPUT_ITEM
2019-09-26 10:14:07 +00:00
}
2019-08-12 13:07:51 +00:00
type OrderEvent implements Node {
id: ID!
date: DateTime
type: OrderEventsEnum
2020-03-03 11:20:39 +00:00
user: User
2019-08-12 13:07:51 +00:00
message: String
email: String
emailType: OrderEventsEmailsEnum
amount: Float
paymentId: String
paymentGateway: String
quantity: Int
composedId: String
orderNumber: String
oversoldItems: [String]
lines: [OrderEventOrderLineObject]
fulfilledItems: [FulfillmentLine]
2020-04-22 14:41:07 +00:00
warehouse: Warehouse
2019-08-12 13:07:51 +00:00
}
type OrderEventCountableConnection {
pageInfo: PageInfo!
edges: [OrderEventCountableEdge!]!
totalCount: Int
}
type OrderEventCountableEdge {
node: OrderEvent!
cursor: String!
}
type OrderEventOrderLineObject {
quantity: Int
orderLine: OrderLine
itemName: String
}
enum OrderEventsEmailsEnum {
PAYMENT_CONFIRMATION
SHIPPING_CONFIRMATION
TRACKING_UPDATED
ORDER_CONFIRMATION
FULFILLMENT_CONFIRMATION
DIGITAL_LINKS
}
enum OrderEventsEnum {
DRAFT_CREATED
DRAFT_ADDED_PRODUCTS
DRAFT_REMOVED_PRODUCTS
PLACED
PLACED_FROM_DRAFT
OVERSOLD_ITEMS
CANCELED
ORDER_MARKED_AS_PAID
ORDER_FULLY_PAID
UPDATED_ADDRESS
EMAIL_SENT
2020-07-01 11:11:08 +00:00
PAYMENT_AUTHORIZED
2019-08-12 13:07:51 +00:00
PAYMENT_CAPTURED
PAYMENT_REFUNDED
PAYMENT_VOIDED
PAYMENT_FAILED
FULFILLMENT_CANCELED
FULFILLMENT_RESTOCKED_ITEMS
FULFILLMENT_FULFILLED_ITEMS
TRACKING_UPDATED
NOTE_ADDED
OTHER
}
input OrderFilterInput {
paymentStatus: [PaymentChargeStatusEnum]
status: [OrderStatusFilter]
customer: String
created: DateRangeInput
2019-09-10 11:28:18 +00:00
search: String
2019-08-12 13:07:51 +00:00
}
2020-04-22 14:41:07 +00:00
type OrderFulfill {
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
fulfillments: [Fulfillment]
order: Order
orderErrors: [OrderError!]!
}
input OrderFulfillInput {
lines: [OrderFulfillLineInput!]!
notifyCustomer: Boolean
}
input OrderFulfillLineInput {
orderLineId: ID
stocks: [OrderFulfillStockInput!]!
}
input OrderFulfillStockInput {
quantity: Int
warehouse: ID
}
2019-08-12 13:07:51 +00:00
type OrderLine implements Node {
id: ID!
productName: String!
2019-09-10 11:28:18 +00:00
variantName: String!
2019-08-12 13:07:51 +00:00
productSku: String!
isShippingRequired: Boolean!
quantity: Int!
quantityFulfilled: Int!
taxRate: Float!
digitalContentUrl: DigitalContentUrl
thumbnail(size: Int): Image
unitPrice: TaxedMoney
variant: ProductVariant
2019-09-10 11:28:18 +00:00
translatedProductName: String!
translatedVariantName: String!
2019-08-12 13:07:51 +00:00
}
input OrderLineCreateInput {
quantity: Int!
variantId: ID!
}
input OrderLineInput {
quantity: Int!
}
type OrderMarkAsPaid {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type OrderRefund {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
2019-12-17 17:13:56 +00:00
enum OrderSortField {
NUMBER
CREATION_DATE
CUSTOMER
PAYMENT
FULFILLMENT_STATUS
TOTAL
}
input OrderSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: OrderSortField!
2019-12-17 17:13:56 +00:00
}
2019-08-12 13:07:51 +00:00
enum OrderStatus {
DRAFT
UNFULFILLED
PARTIALLY_FULFILLED
FULFILLED
CANCELED
}
enum OrderStatusFilter {
READY_TO_FULFILL
READY_TO_CAPTURE
UNFULFILLED
PARTIALLY_FULFILLED
FULFILLED
CANCELED
}
type OrderUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
order: Order
}
input OrderUpdateInput {
billingAddress: AddressInput
userEmail: String
shippingAddress: AddressInput
}
2019-10-09 06:56:46 +00:00
type OrderUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-09 06:56:46 +00:00
order: Order
}
type OrderUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-10-09 06:56:46 +00:00
order: Order
}
2019-08-12 13:07:51 +00:00
type OrderUpdateShipping {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
input OrderUpdateShippingInput {
shippingMethod: ID
}
type OrderVoid {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
order: Order
2020-03-03 11:20:39 +00:00
orderErrors: [OrderError!]!
2019-08-12 13:07:51 +00:00
}
type Page implements Node {
seoTitle: String
seoDescription: String
id: ID!
title: String!
content: String!
contentJson: JSONString!
2019-11-27 10:00:36 +00:00
publicationDate: Date
isPublished: Boolean!
slug: String!
2019-08-12 13:07:51 +00:00
created: DateTime!
translation(languageCode: LanguageCodeEnum!): PageTranslation
}
type PageBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-04-20 11:11:07 +00:00
pageErrors: [PageError!]!
2019-08-12 13:07:51 +00:00
}
type PageBulkPublish {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-04-20 11:11:07 +00:00
pageErrors: [PageError!]!
2019-08-12 13:07:51 +00:00
}
type PageCountableConnection {
pageInfo: PageInfo!
edges: [PageCountableEdge!]!
totalCount: Int
}
type PageCountableEdge {
node: Page!
cursor: String!
}
type PageCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
pageErrors: [PageError!]!
2019-08-12 13:07:51 +00:00
page: Page
}
type PageDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
pageErrors: [PageError!]!
2019-08-12 13:07:51 +00:00
page: Page
}
2020-03-03 11:20:39 +00:00
type PageError {
field: String
message: String
code: PageErrorCode!
}
enum PageErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
2019-09-10 11:28:18 +00:00
input PageFilterInput {
search: String
}
2019-08-12 13:07:51 +00:00
type PageInfo {
hasNextPage: Boolean!
hasPreviousPage: Boolean!
startCursor: String
endCursor: String
}
input PageInput {
slug: String
title: String
content: String
contentJson: JSONString
isPublished: Boolean
publicationDate: String
seo: SeoInput
}
2019-12-17 17:13:56 +00:00
enum PageSortField {
TITLE
SLUG
VISIBILITY
CREATION_DATE
PUBLICATION_DATE
}
input PageSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: PageSortField!
2019-12-17 17:13:56 +00:00
}
2019-11-27 10:00:36 +00:00
type PageTranslatableContent implements Node {
seoTitle: String
seoDescription: String
id: ID!
title: String!
content: String!
contentJson: JSONString!
translation(languageCode: LanguageCodeEnum!): PageTranslation
page: Page
}
2019-08-12 13:07:51 +00:00
type PageTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-11-27 10:00:36 +00:00
page: PageTranslatableContent
2019-08-12 13:07:51 +00:00
}
type PageTranslation implements Node {
seoTitle: String
seoDescription: String
id: ID!
title: String!
content: String!
contentJson: JSONString!
language: LanguageDisplay!
}
input PageTranslationInput {
seoTitle: String
seoDescription: String
title: String
content: String
contentJson: JSONString
}
type PageUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
pageErrors: [PageError!]!
2019-08-12 13:07:51 +00:00
page: Page
}
2019-08-28 14:53:57 +00:00
type PasswordChange {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-28 14:53:57 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-28 14:53:57 +00:00
}
2019-08-12 13:07:51 +00:00
type Payment implements Node {
id: ID!
gateway: String!
isActive: Boolean!
created: DateTime!
modified: DateTime!
token: String!
checkout: Checkout
order: Order
billingEmail: String!
customerIpAddress: String
extraData: String!
chargeStatus: PaymentChargeStatusEnum!
actions: [OrderAction]!
total: Money
capturedAmount: Money
billingAddress: Address
transactions: [Transaction]
availableCaptureAmount: Money
availableRefundAmount: Money
creditCard: CreditCard
}
type PaymentCapture {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
payment: Payment
2020-03-03 11:20:39 +00:00
paymentErrors: [PaymentError!]!
2019-08-12 13:07:51 +00:00
}
enum PaymentChargeStatusEnum {
NOT_CHARGED
PARTIALLY_CHARGED
FULLY_CHARGED
PARTIALLY_REFUNDED
FULLY_REFUNDED
}
type PaymentCountableConnection {
pageInfo: PageInfo!
edges: [PaymentCountableEdge!]!
totalCount: Int
}
type PaymentCountableEdge {
node: Payment!
cursor: String!
}
2019-09-26 10:14:07 +00:00
type PaymentError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: PaymentErrorCode!
2019-09-26 10:14:07 +00:00
}
enum PaymentErrorCode {
BILLING_ADDRESS_NOT_SET
GRAPHQL_ERROR
INVALID
NOT_FOUND
2020-07-01 11:11:08 +00:00
REQUIRED
UNIQUE
2019-09-26 10:14:07 +00:00
PARTIAL_PAYMENT_NOT_ALLOWED
2020-06-10 13:39:10 +00:00
SHIPPING_ADDRESS_NOT_SET
INVALID_SHIPPING_METHOD
SHIPPING_METHOD_NOT_SET
2019-09-26 10:14:07 +00:00
PAYMENT_ERROR
2020-07-01 11:11:08 +00:00
NOT_SUPPORTED_GATEWAY
2019-09-26 10:14:07 +00:00
}
2019-10-09 06:56:46 +00:00
type PaymentGateway {
name: String!
2020-06-10 13:39:10 +00:00
id: ID!
2019-10-09 06:56:46 +00:00
config: [GatewayConfigLine!]!
2020-07-01 11:11:08 +00:00
currencies: [String]!
2019-10-09 06:56:46 +00:00
}
2019-08-12 13:07:51 +00:00
input PaymentInput {
2019-09-26 15:06:14 +00:00
gateway: String!
2019-08-12 13:07:51 +00:00
token: String!
amount: Decimal
billingAddress: AddressInput
}
type PaymentRefund {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
payment: Payment
2020-03-03 11:20:39 +00:00
paymentErrors: [PaymentError!]!
2019-08-12 13:07:51 +00:00
}
2019-08-28 14:53:57 +00:00
type PaymentSecureConfirm {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-28 14:53:57 +00:00
payment: Payment
2020-03-03 11:20:39 +00:00
paymentErrors: [PaymentError!]!
2019-08-28 14:53:57 +00:00
}
2019-08-12 13:07:51 +00:00
type PaymentSource {
gateway: String!
creditCardInfo: CreditCard
}
type PaymentVoid {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
payment: Payment
2020-03-03 11:20:39 +00:00
paymentErrors: [PaymentError!]!
2019-08-12 13:07:51 +00:00
}
2020-04-20 11:11:07 +00:00
type Permission {
2019-08-12 13:07:51 +00:00
code: PermissionEnum!
name: String!
}
enum PermissionEnum {
MANAGE_USERS
MANAGE_STAFF
2019-09-10 11:28:18 +00:00
MANAGE_SERVICE_ACCOUNTS
MANAGE_APPS
2019-08-12 13:07:51 +00:00
MANAGE_DISCOUNTS
MANAGE_PLUGINS
2020-01-17 15:16:05 +00:00
MANAGE_GIFT_CARD
2019-08-12 13:07:51 +00:00
MANAGE_MENUS
MANAGE_ORDERS
MANAGE_PAGES
MANAGE_PRODUCTS
MANAGE_SHIPPING
MANAGE_SETTINGS
MANAGE_TRANSLATIONS
2019-09-26 15:06:14 +00:00
MANAGE_WEBHOOKS
2020-01-09 11:13:24 +00:00
MANAGE_CHECKOUTS
2019-08-12 13:07:51 +00:00
}
2020-03-03 11:20:39 +00:00
type PermissionGroupCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
permissionGroupErrors: [PermissionGroupError!]!
2020-07-01 11:11:08 +00:00
group: Group
2020-03-03 11:20:39 +00:00
}
input PermissionGroupCreateInput {
2020-04-20 11:11:07 +00:00
addPermissions: [PermissionEnum!]
addUsers: [ID!]
2020-03-03 11:20:39 +00:00
name: String!
}
type PermissionGroupDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
permissionGroupErrors: [PermissionGroupError!]!
2020-03-03 11:20:39 +00:00
group: Group
}
2020-04-20 11:11:07 +00:00
type PermissionGroupError {
field: String
message: String
code: PermissionGroupErrorCode!
permissions: [PermissionEnum!]
users: [ID!]
2020-03-03 11:20:39 +00:00
}
2020-04-20 11:11:07 +00:00
enum PermissionGroupErrorCode {
ASSIGN_NON_STAFF_MEMBER
DUPLICATED_INPUT_ITEM
2020-04-20 11:11:07 +00:00
CANNOT_REMOVE_FROM_LAST_GROUP
LEFT_NOT_MANAGEABLE_PERMISSION
OUT_OF_SCOPE_PERMISSION
OUT_OF_SCOPE_USER
REQUIRED
UNIQUE
}
input PermissionGroupFilterInput {
search: String
2020-03-03 11:20:39 +00:00
}
enum PermissionGroupSortField {
NAME
}
input PermissionGroupSortingInput {
direction: OrderDirection!
field: PermissionGroupSortField!
}
2020-04-20 11:11:07 +00:00
type PermissionGroupUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
permissionGroupErrors: [PermissionGroupError!]!
2020-07-01 11:11:08 +00:00
group: Group
2020-03-03 11:20:39 +00:00
}
2020-04-20 11:11:07 +00:00
input PermissionGroupUpdateInput {
addPermissions: [PermissionEnum!]
addUsers: [ID!]
name: String
removePermissions: [PermissionEnum!]
removeUsers: [ID!]
2020-03-03 11:20:39 +00:00
}
2019-08-28 14:53:57 +00:00
type Plugin implements Node {
2020-04-20 11:11:07 +00:00
id: ID!
2019-08-12 13:07:51 +00:00
name: String!
description: String!
active: Boolean!
configuration: [ConfigurationItem]
}
2019-08-28 14:53:57 +00:00
type PluginCountableConnection {
2019-08-12 13:07:51 +00:00
pageInfo: PageInfo!
2019-08-28 14:53:57 +00:00
edges: [PluginCountableEdge!]!
2019-08-12 13:07:51 +00:00
totalCount: Int
}
2019-08-28 14:53:57 +00:00
type PluginCountableEdge {
node: Plugin!
2019-08-12 13:07:51 +00:00
cursor: String!
}
2020-04-20 11:11:07 +00:00
type PluginError {
field: String
message: String
code: PluginErrorCode!
}
enum PluginErrorCode {
GRAPHQL_ERROR
INVALID
PLUGIN_MISCONFIGURED
NOT_FOUND
REQUIRED
UNIQUE
}
2019-09-10 11:28:18 +00:00
input PluginFilterInput {
active: Boolean
search: String
}
2019-12-17 17:13:56 +00:00
enum PluginSortField {
NAME
IS_ACTIVE
}
input PluginSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: PluginSortField!
2019-12-17 17:13:56 +00:00
}
2019-08-28 14:53:57 +00:00
type PluginUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-28 14:53:57 +00:00
plugin: Plugin
2020-04-20 11:11:07 +00:00
pluginsErrors: [PluginError!]!
2019-08-12 13:07:51 +00:00
}
2019-08-28 14:53:57 +00:00
input PluginUpdateInput {
2019-08-12 13:07:51 +00:00
active: Boolean
configuration: [ConfigurationItemInput]
}
input PriceRangeInput {
gte: Float
lte: Float
}
2020-03-03 11:20:39 +00:00
type Product implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
id: ID!
seoTitle: String
seoDescription: String
name: String!
description: String!
descriptionJson: JSONString!
2019-11-27 10:00:36 +00:00
publicationDate: Date
isPublished: Boolean!
productType: ProductType!
2020-03-03 11:20:39 +00:00
slug: String!
2019-11-27 10:00:36 +00:00
category: Category
2019-08-12 13:07:51 +00:00
updatedAt: DateTime
chargeTaxes: Boolean!
weight: Weight
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
url: String! @deprecated(reason: "This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
thumbnail(size: Int): Image
pricing: ProductPricingInfo
isAvailable: Boolean
2019-08-28 14:53:57 +00:00
minimalVariantPrice: Money
2019-08-12 13:07:51 +00:00
taxType: TaxType
attributes: [SelectedAttribute!]!
purchaseCost: MoneyRange
margin: Margin
imageById(id: ID): ProductImage
variants: [ProductVariant]
images: [ProductImage]
collections: [Collection]
translation(languageCode: LanguageCodeEnum!): ProductTranslation
}
2020-04-20 11:11:07 +00:00
type ProductAttributeError {
field: String
message: String
code: ProductErrorCode!
attributes: [ID!]
}
2019-08-12 13:07:51 +00:00
type ProductBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type ProductBulkPublish {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type ProductClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
type ProductClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
type ProductCountableConnection {
pageInfo: PageInfo!
edges: [ProductCountableEdge!]!
totalCount: Int
}
type ProductCountableEdge {
node: Product!
cursor: String!
}
type ProductCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
input ProductCreateInput {
attributes: [AttributeValueInput]
publicationDate: Date
category: ID
chargeTaxes: Boolean
collections: [ID]
description: String
descriptionJson: JSONString
isPublished: Boolean
name: String
2020-03-03 11:20:39 +00:00
slug: String
2019-08-12 13:07:51 +00:00
taxCode: String
seo: SeoInput
weight: WeightScalar
sku: String
trackInventory: Boolean
2020-06-10 13:39:10 +00:00
basePrice: Decimal
2019-08-12 13:07:51 +00:00
productType: ID!
2020-03-09 14:59:58 +00:00
stocks: [StockInput!]
2019-08-12 13:07:51 +00:00
}
type ProductDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
2019-09-26 10:14:07 +00:00
type ProductError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: ProductErrorCode!
2019-09-26 10:14:07 +00:00
}
enum ProductErrorCode {
ALREADY_EXISTS
ATTRIBUTE_ALREADY_ASSIGNED
ATTRIBUTE_CANNOT_BE_ASSIGNED
ATTRIBUTE_VARIANTS_DISABLED
DUPLICATED_INPUT_ITEM
2019-09-26 10:14:07 +00:00
GRAPHQL_ERROR
INVALID
NOT_PRODUCTS_IMAGE
NOT_FOUND
REQUIRED
UNIQUE
VARIANT_NO_DIGITAL_CONTENT
}
2019-08-12 13:07:51 +00:00
input ProductFilterInput {
isPublished: Boolean
collections: [ID]
categories: [ID]
2019-11-27 10:00:36 +00:00
hasCategory: Boolean
2019-08-12 13:07:51 +00:00
attributes: [AttributeInput]
stockAvailability: StockAvailability
productType: ID
2020-03-09 14:59:58 +00:00
stocks: ProductStockFilterInput
2019-08-12 13:07:51 +00:00
search: String
2020-06-10 13:39:10 +00:00
price: PriceRangeInput
2019-08-28 14:53:57 +00:00
minimalPrice: PriceRangeInput
2020-01-17 15:16:05 +00:00
productTypes: [ID]
2019-08-12 13:07:51 +00:00
}
type ProductImage implements Node {
id: ID!
2020-01-09 11:13:24 +00:00
sortOrder: Int
2019-08-12 13:07:51 +00:00
alt: String!
url(size: Int): String!
}
type ProductImageBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type ProductImageCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
product: Product
image: ProductImage
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
input ProductImageCreateInput {
alt: String
image: Upload!
product: ID!
}
type ProductImageDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
product: Product
image: ProductImage
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type ProductImageReorder {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
product: Product
images: [ProductImage]
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type ProductImageUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
product: Product
image: ProductImage
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
input ProductImageUpdateInput {
alt: String
}
input ProductInput {
attributes: [AttributeValueInput]
publicationDate: Date
category: ID
chargeTaxes: Boolean
collections: [ID]
description: String
descriptionJson: JSONString
isPublished: Boolean
name: String
2020-03-03 11:20:39 +00:00
slug: String
2019-08-12 13:07:51 +00:00
taxCode: String
seo: SeoInput
weight: WeightScalar
sku: String
trackInventory: Boolean
2020-06-10 13:39:10 +00:00
basePrice: Decimal
2019-08-12 13:07:51 +00:00
}
input ProductOrder {
direction: OrderDirection!
2019-12-17 17:13:56 +00:00
attributeId: ID
field: ProductOrderField
2019-08-12 13:07:51 +00:00
}
enum ProductOrderField {
NAME
PRICE
2019-08-28 14:53:57 +00:00
MINIMAL_PRICE
2019-08-12 13:07:51 +00:00
DATE
2019-09-10 11:28:18 +00:00
TYPE
PUBLISHED
2019-08-12 13:07:51 +00:00
}
type ProductPricingInfo {
onSale: Boolean
discount: TaxedMoney
discountLocalCurrency: TaxedMoney
priceRange: TaxedMoneyRange
priceRangeUndiscounted: TaxedMoneyRange
priceRangeLocalCurrency: TaxedMoneyRange
}
2020-03-09 14:59:58 +00:00
input ProductStockFilterInput {
warehouseIds: [ID!]
quantity: IntRangeInput
}
2019-11-27 10:00:36 +00:00
type ProductTranslatableContent implements Node {
id: ID!
seoTitle: String
seoDescription: String
name: String!
description: String!
descriptionJson: JSONString!
translation(languageCode: LanguageCodeEnum!): ProductTranslation
product: Product
}
2019-08-12 13:07:51 +00:00
type ProductTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
type ProductTranslation implements Node {
id: ID!
seoTitle: String
seoDescription: String
name: String!
description: String!
descriptionJson: JSONString!
language: LanguageDisplay!
}
2020-03-03 11:20:39 +00:00
type ProductType implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
id: ID!
name: String!
2020-03-03 11:20:39 +00:00
slug: String!
2019-08-12 13:07:51 +00:00
hasVariants: Boolean!
isShippingRequired: Boolean!
isDigital: Boolean!
weight: Weight
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
products(before: String, after: String, first: Int, last: Int): ProductCountableConnection
2019-08-12 13:07:51 +00:00
taxRate: TaxRateType
taxType: TaxType
variantAttributes: [Attribute]
productAttributes: [Attribute]
2020-04-22 14:41:07 +00:00
availableAttributes(filter: AttributeFilterInput, before: String, after: String, first: Int, last: Int): AttributeCountableConnection
2019-08-12 13:07:51 +00:00
}
type ProductTypeBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type ProductTypeClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productType: ProductType
}
type ProductTypeClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productType: ProductType
}
enum ProductTypeConfigurable {
CONFIGURABLE
SIMPLE
}
type ProductTypeCountableConnection {
pageInfo: PageInfo!
edges: [ProductTypeCountableEdge!]!
totalCount: Int
}
type ProductTypeCountableEdge {
node: ProductType!
cursor: String!
}
type ProductTypeCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productType: ProductType
}
type ProductTypeDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productType: ProductType
}
enum ProductTypeEnum {
DIGITAL
SHIPPABLE
}
input ProductTypeFilterInput {
2019-08-28 14:53:57 +00:00
search: String
2019-08-12 13:07:51 +00:00
configurable: ProductTypeConfigurable
productType: ProductTypeEnum
2020-01-17 15:16:05 +00:00
ids: [ID]
2019-08-12 13:07:51 +00:00
}
input ProductTypeInput {
name: String
2020-03-03 11:20:39 +00:00
slug: String
2019-08-12 13:07:51 +00:00
hasVariants: Boolean
productAttributes: [ID]
variantAttributes: [ID]
isShippingRequired: Boolean
isDigital: Boolean
weight: WeightScalar
taxCode: String
}
type ProductTypeReorderAttributes {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
productType: ProductType
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
2019-12-17 17:13:56 +00:00
enum ProductTypeSortField {
NAME
DIGITAL
SHIPPING_REQUIRED
}
input ProductTypeSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: ProductTypeSortField!
2019-12-17 17:13:56 +00:00
}
2019-08-12 13:07:51 +00:00
type ProductTypeUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productType: ProductType
}
type ProductTypeUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productType: ProductType
}
type ProductTypeUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productType: ProductType
}
type ProductUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
type ProductUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
type ProductUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
product: Product
}
2020-03-03 11:20:39 +00:00
type ProductVariant implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
id: ID!
name: String!
2019-11-27 10:00:36 +00:00
sku: String!
2019-08-12 13:07:51 +00:00
product: Product!
trackInventory: Boolean!
weight: Weight
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
quantity: Int! @deprecated(reason: "Use the stock field instead. This field will be removed after 2020-07-31.")
quantityAllocated: Int @deprecated(reason: "Use the stock field instead. This field will be removed after 2020-07-31.")
2020-06-10 13:39:10 +00:00
stockQuantity: Int! @deprecated(reason: "Use the quantityAvailable field instead. This field will be removed after 2020-07-31.")
price: Money
2019-08-12 13:07:51 +00:00
pricing: VariantPricingInfo
2020-04-22 14:41:07 +00:00
isAvailable: Boolean @deprecated(reason: "Use the stock field instead. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
attributes: [SelectedAttribute!]!
costPrice: Money
margin: Int
quantityOrdered: Int
revenue(period: ReportingPeriod): TaxedMoney
images: [ProductImage]
translation(languageCode: LanguageCodeEnum!): ProductVariantTranslation
digitalContent: DigitalContent
2020-03-09 14:59:58 +00:00
stocks(countryCode: CountryCode): [Stock]
2020-06-10 13:39:10 +00:00
quantityAvailable(countryCode: CountryCode): Int!
2019-08-12 13:07:51 +00:00
}
2019-09-26 15:06:14 +00:00
type ProductVariantBulkCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-09-26 15:06:14 +00:00
count: Int!
productVariants: [ProductVariant!]!
2020-03-03 11:20:39 +00:00
bulkProductErrors: [BulkProductError!]!
2019-09-26 15:06:14 +00:00
}
input ProductVariantBulkCreateInput {
attributes: [AttributeValueInput]!
costPrice: Decimal
2020-06-10 13:39:10 +00:00
price: Decimal
2019-09-26 15:06:14 +00:00
sku: String!
trackInventory: Boolean
weight: WeightScalar
2020-04-22 14:41:07 +00:00
stocks: [StockInput!]
2019-09-26 15:06:14 +00:00
}
2019-08-12 13:07:51 +00:00
type ProductVariantBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type ProductVariantClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
type ProductVariantClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
type ProductVariantCountableConnection {
pageInfo: PageInfo!
edges: [ProductVariantCountableEdge!]!
totalCount: Int
}
type ProductVariantCountableEdge {
node: ProductVariant!
cursor: String!
}
type ProductVariantCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
input ProductVariantCreateInput {
attributes: [AttributeValueInput]!
costPrice: Decimal
2020-06-10 13:39:10 +00:00
price: Decimal
2019-08-12 13:07:51 +00:00
sku: String
trackInventory: Boolean
weight: WeightScalar
product: ID!
2020-03-09 14:59:58 +00:00
stocks: [StockInput!]
2019-08-12 13:07:51 +00:00
}
type ProductVariantDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
input ProductVariantInput {
attributes: [AttributeValueInput]
costPrice: Decimal
2020-06-10 13:39:10 +00:00
price: Decimal
2019-08-12 13:07:51 +00:00
sku: String
trackInventory: Boolean
weight: WeightScalar
}
2020-03-09 14:59:58 +00:00
type ProductVariantStocksCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-09 14:59:58 +00:00
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]!
}
type ProductVariantStocksDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-09 14:59:58 +00:00
productVariant: ProductVariant
stockErrors: [StockError!]!
}
type ProductVariantStocksUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-09 14:59:58 +00:00
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]!
}
2019-11-27 10:00:36 +00:00
type ProductVariantTranslatableContent implements Node {
id: ID!
name: String!
translation(languageCode: LanguageCodeEnum!): ProductVariantTranslation
productVariant: ProductVariant
}
2019-08-12 13:07:51 +00:00
type ProductVariantTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
type ProductVariantTranslation implements Node {
id: ID!
name: String!
language: LanguageDisplay!
}
type ProductVariantUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
type ProductVariantUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
type ProductVariantUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
}
type Query {
2019-09-26 15:06:14 +00:00
webhook(id: ID!): Webhook
2020-04-22 14:41:07 +00:00
webhooks(sortBy: WebhookSortingInput, filter: WebhookFilterInput, before: String, after: String, first: Int, last: Int): WebhookCountableConnection @deprecated(reason: "Use webhooks field on app(s) query instead. This field will be removed after 2020-07-31.")
2019-10-25 12:18:52 +00:00
webhookEvents: [WebhookEvent]
2020-03-03 11:20:39 +00:00
webhookSamplePayload(eventType: WebhookSampleEventTypeEnum!): JSONString
2020-01-17 15:16:05 +00:00
warehouse(id: ID!): Warehouse
2020-04-22 14:41:07 +00:00
warehouses(filter: WarehouseFilterInput, sortBy: WarehouseSortingInput, before: String, after: String, first: Int, last: Int): WarehouseCountableConnection
translations(kind: TranslatableKinds!, before: String, after: String, first: Int, last: Int): TranslatableItemConnection
2020-01-17 15:16:05 +00:00
translation(id: ID!, kind: TranslatableKinds!): TranslatableItem
stock(id: ID!): Stock
2020-04-22 14:41:07 +00:00
stocks(filter: StockFilterInput, before: String, after: String, first: Int, last: Int): StockCountableConnection
2020-03-03 11:20:39 +00:00
shop: Shop!
2019-08-12 13:07:51 +00:00
shippingZone(id: ID!): ShippingZone
2020-04-22 14:41:07 +00:00
shippingZones(before: String, after: String, first: Int, last: Int): ShippingZoneCountableConnection
2019-08-12 13:07:51 +00:00
digitalContent(id: ID!): DigitalContent
2020-04-22 14:41:07 +00:00
digitalContents(before: String, after: String, first: Int, last: Int): DigitalContentCountableConnection
attributes(filter: AttributeFilterInput, sortBy: AttributeSortingInput, before: String, after: String, first: Int, last: Int): AttributeCountableConnection
2019-08-12 13:07:51 +00:00
attribute(id: ID!): Attribute
2020-04-22 14:41:07 +00:00
categories(filter: CategoryFilterInput, sortBy: CategorySortingInput, level: Int, before: String, after: String, first: Int, last: Int): CategoryCountableConnection
2020-06-10 13:39:10 +00:00
category(id: ID, slug: String): Category
collection(id: ID, slug: String): Collection
2020-04-22 14:41:07 +00:00
collections(filter: CollectionFilterInput, sortBy: CollectionSortingInput, before: String, after: String, first: Int, last: Int): CollectionCountableConnection
2020-06-10 13:39:10 +00:00
product(id: ID, slug: String): Product
2020-04-22 14:41:07 +00:00
products(filter: ProductFilterInput, sortBy: ProductOrder, stockAvailability: StockAvailability, before: String, after: String, first: Int, last: Int): ProductCountableConnection
2019-08-12 13:07:51 +00:00
productType(id: ID!): ProductType
2020-04-22 14:41:07 +00:00
productTypes(filter: ProductTypeFilterInput, sortBy: ProductTypeSortingInput, before: String, after: String, first: Int, last: Int): ProductTypeCountableConnection
2019-08-12 13:07:51 +00:00
productVariant(id: ID!): ProductVariant
2020-04-22 14:41:07 +00:00
productVariants(ids: [ID], before: String, after: String, first: Int, last: Int): ProductVariantCountableConnection
reportProductSales(period: ReportingPeriod!, before: String, after: String, first: Int, last: Int): ProductVariantCountableConnection
2019-09-26 10:14:07 +00:00
payment(id: ID!): Payment
2020-04-22 14:41:07 +00:00
payments(before: String, after: String, first: Int, last: Int): PaymentCountableConnection
2019-08-12 13:07:51 +00:00
page(id: ID, slug: String): Page
2020-04-22 14:41:07 +00:00
pages(sortBy: PageSortingInput, filter: PageFilterInput, before: String, after: String, first: Int, last: Int): PageCountableConnection
homepageEvents(before: String, after: String, first: Int, last: Int): OrderEventCountableConnection
2019-08-12 13:07:51 +00:00
order(id: ID!): Order
2020-04-22 14:41:07 +00:00
orders(sortBy: OrderSortingInput, filter: OrderFilterInput, created: ReportingPeriod, status: OrderStatusFilter, before: String, after: String, first: Int, last: Int): OrderCountableConnection
draftOrders(sortBy: OrderSortingInput, filter: OrderDraftFilterInput, created: ReportingPeriod, before: String, after: String, first: Int, last: Int): OrderCountableConnection
2019-08-12 13:07:51 +00:00
ordersTotal(period: ReportingPeriod): TaxedMoney
2019-09-26 10:14:07 +00:00
orderByToken(token: UUID!): Order
2019-08-12 13:07:51 +00:00
menu(id: ID, name: String): Menu
2020-04-22 14:41:07 +00:00
menus(sortBy: MenuSortingInput, filter: MenuFilterInput, before: String, after: String, first: Int, last: Int): MenuCountableConnection
2019-08-12 13:07:51 +00:00
menuItem(id: ID!): MenuItem
2020-04-22 14:41:07 +00:00
menuItems(sortBy: MenuItemSortingInput, filter: MenuItemFilterInput, before: String, after: String, first: Int, last: Int): MenuItemCountableConnection
2019-08-12 13:07:51 +00:00
giftCard(id: ID!): GiftCard
2020-04-22 14:41:07 +00:00
giftCards(before: String, after: String, first: Int, last: Int): GiftCardCountableConnection
2019-08-28 14:53:57 +00:00
plugin(id: ID!): Plugin
2020-04-22 14:41:07 +00:00
plugins(filter: PluginFilterInput, sortBy: PluginSortingInput, before: String, after: String, first: Int, last: Int): PluginCountableConnection
2019-08-12 13:07:51 +00:00
sale(id: ID!): Sale
2020-04-22 14:41:07 +00:00
sales(filter: SaleFilterInput, sortBy: SaleSortingInput, query: String, before: String, after: String, first: Int, last: Int): SaleCountableConnection
2019-08-12 13:07:51 +00:00
voucher(id: ID!): Voucher
2020-04-22 14:41:07 +00:00
vouchers(filter: VoucherFilterInput, sortBy: VoucherSortingInput, query: String, before: String, after: String, first: Int, last: Int): VoucherCountableConnection
2019-08-12 13:07:51 +00:00
taxTypes: [TaxType]
checkout(token: UUID): Checkout
2020-04-22 14:41:07 +00:00
checkouts(before: String, after: String, first: Int, last: Int): CheckoutCountableConnection
2019-08-12 13:07:51 +00:00
checkoutLine(id: ID): CheckoutLine
2020-04-22 14:41:07 +00:00
checkoutLines(before: String, after: String, first: Int, last: Int): CheckoutLineCountableConnection
apps(filter: AppFilterInput, sortBy: AppSortingInput, before: String, after: String, first: Int, last: Int): AppCountableConnection
app(id: ID!): App
addressValidationRules(countryCode: CountryCode!, countryArea: String, city: String, cityArea: String): AddressValidationData
2020-01-09 11:13:24 +00:00
address(id: ID!): Address
2020-04-22 14:41:07 +00:00
customers(filter: CustomerFilterInput, sortBy: UserSortingInput, before: String, after: String, first: Int, last: Int): UserCountableConnection
permissionGroups(filter: PermissionGroupFilterInput, sortBy: PermissionGroupSortingInput, before: String, after: String, first: Int, last: Int): GroupCountableConnection
2020-03-03 11:20:39 +00:00
permissionGroup(id: ID!): Group
2019-08-12 13:07:51 +00:00
me: User
2020-04-22 14:41:07 +00:00
staffUsers(filter: StaffUserInput, sortBy: UserSortingInput, before: String, after: String, first: Int, last: Int): UserCountableConnection
serviceAccounts(filter: ServiceAccountFilterInput, sortBy: ServiceAccountSortingInput, before: String, after: String, first: Int, last: Int): ServiceAccountCountableConnection @deprecated(reason: "Use the `apps` query instead. This field will be removed after 2020-07-31.")
serviceAccount(id: ID!): ServiceAccount @deprecated(reason: "Use the `app` query instead. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user(id: ID!): User
2019-10-17 15:29:13 +00:00
_entities(representations: [_Any]): [_Entity]
_service: _Service
2019-08-12 13:07:51 +00:00
}
type ReducedRate {
rate: Float!
rateType: TaxRateType!
}
2020-04-22 14:41:07 +00:00
type RefreshToken {
2020-07-01 11:11:08 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
token: String
2020-07-01 11:11:08 +00:00
user: User
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
input ReorderInput {
id: ID!
sortOrder: Int
}
enum ReportingPeriod {
TODAY
THIS_MONTH
}
2020-01-17 15:16:05 +00:00
type RequestEmailChange {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-01-17 15:16:05 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2020-01-17 15:16:05 +00:00
}
2019-08-12 13:07:51 +00:00
type RequestPasswordReset {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type Sale implements Node {
id: ID!
name: String!
type: SaleType!
value: Float!
startDate: DateTime!
endDate: DateTime
2020-04-22 14:41:07 +00:00
categories(before: String, after: String, first: Int, last: Int): CategoryCountableConnection
collections(before: String, after: String, first: Int, last: Int): CollectionCountableConnection
products(before: String, after: String, first: Int, last: Int): ProductCountableConnection
2019-08-12 13:07:51 +00:00
translation(languageCode: LanguageCodeEnum!): SaleTranslation
}
type SaleAddCatalogues {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
sale: Sale
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
}
type SaleBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-04-20 11:11:07 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
}
type SaleCountableConnection {
pageInfo: PageInfo!
edges: [SaleCountableEdge!]!
totalCount: Int
}
type SaleCountableEdge {
node: Sale!
cursor: String!
}
type SaleCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
sale: Sale
}
type SaleDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
sale: Sale
}
input SaleFilterInput {
status: [DiscountStatusEnum]
saleType: DiscountValueTypeEnum
started: DateTimeRangeInput
search: String
}
input SaleInput {
name: String
type: DiscountValueTypeEnum
value: Decimal
products: [ID]
categories: [ID]
collections: [ID]
startDate: DateTime
endDate: DateTime
}
type SaleRemoveCatalogues {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
sale: Sale
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
}
2019-12-17 17:13:56 +00:00
enum SaleSortField {
NAME
START_DATE
END_DATE
VALUE
TYPE
}
input SaleSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: SaleSortField!
2019-12-17 17:13:56 +00:00
}
2019-11-27 10:00:36 +00:00
type SaleTranslatableContent implements Node {
id: ID!
name: String!
translation(languageCode: LanguageCodeEnum!): SaleTranslation
sale: Sale
}
2019-08-12 13:07:51 +00:00
type SaleTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
sale: Sale
}
type SaleTranslation implements Node {
id: ID!
name: String
language: LanguageDisplay!
}
enum SaleType {
FIXED
PERCENTAGE
}
type SaleUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
sale: Sale
}
type SelectedAttribute {
attribute: Attribute!
values: [AttributeValue]!
}
input SeoInput {
title: String
description: String
}
2020-03-03 11:20:39 +00:00
type ServiceAccount implements Node & ObjectWithMetadata {
2019-09-10 11:28:18 +00:00
id: ID!
2020-03-23 17:59:10 +00:00
name: String
2019-09-10 11:28:18 +00:00
created: DateTime
isActive: Boolean
2020-04-20 11:11:07 +00:00
permissions: [Permission]
2019-09-26 15:06:14 +00:00
tokens: [ServiceAccountToken]
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2019-09-10 11:28:18 +00:00
}
2019-10-09 06:56:46 +00:00
type ServiceAccountClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-09-10 11:28:18 +00:00
serviceAccount: ServiceAccount
}
type ServiceAccountCountableConnection {
pageInfo: PageInfo!
edges: [ServiceAccountCountableEdge!]!
totalCount: Int
}
type ServiceAccountCountableEdge {
node: ServiceAccount!
cursor: String!
}
type ServiceAccountCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-09-10 11:28:18 +00:00
authToken: String
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-09-10 11:28:18 +00:00
serviceAccount: ServiceAccount
}
type ServiceAccountDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-09-10 11:28:18 +00:00
serviceAccount: ServiceAccount
}
input ServiceAccountFilterInput {
search: String
isActive: Boolean
}
input ServiceAccountInput {
name: String
isActive: Boolean
permissions: [PermissionEnum]
}
2019-12-17 17:13:56 +00:00
enum ServiceAccountSortField {
NAME
CREATION_DATE
}
input ServiceAccountSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: ServiceAccountSortField!
2019-12-17 17:13:56 +00:00
}
2019-09-26 15:06:14 +00:00
type ServiceAccountToken implements Node {
name: String
authToken: String
id: ID!
}
type ServiceAccountTokenCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-09-26 15:06:14 +00:00
authToken: String
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-09-26 15:06:14 +00:00
serviceAccountToken: ServiceAccountToken
}
type ServiceAccountTokenDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-09-26 15:06:14 +00:00
serviceAccountToken: ServiceAccountToken
}
input ServiceAccountTokenInput {
name: String
serviceAccount: ID!
}
2019-09-10 11:28:18 +00:00
type ServiceAccountUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-09-10 11:28:18 +00:00
serviceAccount: ServiceAccount
}
type ServiceAccountUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-09-10 11:28:18 +00:00
serviceAccount: ServiceAccount
}
2019-08-12 13:07:51 +00:00
type SetPassword {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-07-01 11:11:08 +00:00
token: String
refreshToken: String
csrfToken: String
2019-08-12 13:07:51 +00:00
user: User
2020-07-01 11:11:08 +00:00
accountErrors: [AccountError!]!
2019-09-26 10:14:07 +00:00
}
type ShippingError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: ShippingErrorCode!
2020-04-20 11:11:07 +00:00
warehouses: [ID!]
2019-09-26 10:14:07 +00:00
}
enum ShippingErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
MAX_LESS_THAN_MIN
NOT_FOUND
REQUIRED
UNIQUE
DUPLICATED_INPUT_ITEM
2019-08-12 13:07:51 +00:00
}
type ShippingMethod implements Node {
id: ID!
name: String!
price: Money
minimumOrderPrice: Money
maximumOrderPrice: Money
minimumOrderWeight: Weight
maximumOrderWeight: Weight
type: ShippingMethodTypeEnum
translation(languageCode: LanguageCodeEnum!): ShippingMethodTranslation
}
2019-11-27 10:00:36 +00:00
type ShippingMethodTranslatableContent implements Node {
id: ID!
name: String!
translation(languageCode: LanguageCodeEnum!): ShippingMethodTranslation
shippingMethod: ShippingMethod
}
2019-08-12 13:07:51 +00:00
type ShippingMethodTranslation implements Node {
id: ID!
name: String
language: LanguageDisplay!
}
enum ShippingMethodTypeEnum {
PRICE
WEIGHT
}
type ShippingPriceBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
shippingErrors: [ShippingError!]!
2019-08-12 13:07:51 +00:00
}
type ShippingPriceCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shippingZone: ShippingZone
2020-03-03 11:20:39 +00:00
shippingErrors: [ShippingError!]!
2019-08-12 13:07:51 +00:00
shippingMethod: ShippingMethod
}
type ShippingPriceDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shippingMethod: ShippingMethod
shippingZone: ShippingZone
2020-03-03 11:20:39 +00:00
shippingErrors: [ShippingError!]!
2019-08-12 13:07:51 +00:00
}
input ShippingPriceInput {
name: String
price: Decimal
minimumOrderPrice: Decimal
maximumOrderPrice: Decimal
minimumOrderWeight: WeightScalar
maximumOrderWeight: WeightScalar
type: ShippingMethodTypeEnum
shippingZone: ID
}
type ShippingPriceTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
shippingMethod: ShippingMethod
}
type ShippingPriceUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shippingZone: ShippingZone
2020-03-03 11:20:39 +00:00
shippingErrors: [ShippingError!]!
2019-08-12 13:07:51 +00:00
shippingMethod: ShippingMethod
}
type ShippingZone implements Node {
id: ID!
name: String!
default: Boolean!
priceRange: MoneyRange
countries: [CountryDisplay]
shippingMethods: [ShippingMethod]
2020-03-03 11:20:39 +00:00
warehouses: [Warehouse]
2019-08-12 13:07:51 +00:00
}
type ShippingZoneBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
shippingErrors: [ShippingError!]!
2019-08-12 13:07:51 +00:00
}
type ShippingZoneCountableConnection {
pageInfo: PageInfo!
edges: [ShippingZoneCountableEdge!]!
totalCount: Int
}
type ShippingZoneCountableEdge {
node: ShippingZone!
cursor: String!
}
type ShippingZoneCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
shippingErrors: [ShippingError!]!
2020-07-01 11:11:08 +00:00
shippingZone: ShippingZone
2019-08-12 13:07:51 +00:00
}
2020-04-20 11:11:07 +00:00
input ShippingZoneCreateInput {
2019-08-12 13:07:51 +00:00
name: String
countries: [String]
default: Boolean
2020-04-20 11:11:07 +00:00
addWarehouses: [ID]
}
type ShippingZoneDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
shippingErrors: [ShippingError!]!
shippingZone: ShippingZone
2019-08-12 13:07:51 +00:00
}
type ShippingZoneUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
shippingErrors: [ShippingError!]!
2020-07-01 11:11:08 +00:00
shippingZone: ShippingZone
2019-08-12 13:07:51 +00:00
}
2020-04-20 11:11:07 +00:00
input ShippingZoneUpdateInput {
name: String
countries: [String]
default: Boolean
addWarehouses: [ID]
removeWarehouses: [ID]
}
2019-08-12 13:07:51 +00:00
type Shop {
2020-07-01 11:11:08 +00:00
availablePaymentGateways(currency: String): [PaymentGateway!]!
2019-08-12 13:07:51 +00:00
geolocalization: Geolocalization
authorizationKeys: [AuthorizationKey]!
2020-06-10 13:39:10 +00:00
countries(languageCode: LanguageCodeEnum): [CountryDisplay!]!
2019-08-12 13:07:51 +00:00
currencies: [String]!
defaultCurrency: String!
defaultCountry: CountryDisplay
2019-10-25 12:18:52 +00:00
defaultMailSenderName: String
defaultMailSenderAddress: String
2019-08-12 13:07:51 +00:00
description: String
domain: Domain!
homepageCollection: Collection
languages: [LanguageDisplay]!
name: String!
navigation: Navigation
2020-04-20 11:11:07 +00:00
permissions: [Permission]!
2019-08-12 13:07:51 +00:00
phonePrefixes: [String]!
headerText: String
includeTaxesInPrices: Boolean!
displayGrossPrices: Boolean!
chargeTaxesOnShipping: Boolean!
trackInventoryByDefault: Boolean
defaultWeightUnit: WeightUnitsEnum
translation(languageCode: LanguageCodeEnum!): ShopTranslation
automaticFulfillmentDigitalProducts: Boolean
defaultDigitalMaxDownloads: Int
defaultDigitalUrlValidDays: Int
companyAddress: Address
2019-10-25 12:18:52 +00:00
customerSetPasswordUrl: String
2020-01-17 15:16:05 +00:00
staffNotificationRecipients: [StaffNotificationRecipient]
2019-08-12 13:07:51 +00:00
}
type ShopAddressUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shop: Shop
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2019-08-12 13:07:51 +00:00
}
type ShopDomainUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shop: Shop
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2019-09-26 10:14:07 +00:00
}
type ShopError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: ShopErrorCode!
2019-09-26 10:14:07 +00:00
}
enum ShopErrorCode {
ALREADY_EXISTS
CANNOT_FETCH_TAX_RATES
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
2019-08-12 13:07:51 +00:00
}
type ShopFetchTaxRates {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shop: Shop
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2019-08-12 13:07:51 +00:00
}
input ShopSettingsInput {
headerText: String
description: String
includeTaxesInPrices: Boolean
displayGrossPrices: Boolean
chargeTaxesOnShipping: Boolean
trackInventoryByDefault: Boolean
defaultWeightUnit: WeightUnitsEnum
automaticFulfillmentDigitalProducts: Boolean
defaultDigitalMaxDownloads: Int
defaultDigitalUrlValidDays: Int
2019-10-25 12:18:52 +00:00
defaultMailSenderName: String
defaultMailSenderAddress: String
customerSetPasswordUrl: String
2019-08-12 13:07:51 +00:00
}
type ShopSettingsTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shop: Shop
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
}
input ShopSettingsTranslationInput {
headerText: String
description: String
}
type ShopSettingsUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
shop: Shop
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2019-08-12 13:07:51 +00:00
}
type ShopTranslation implements Node {
id: ID!
headerText: String!
description: String!
language: LanguageDisplay!
}
input SiteDomainInput {
domain: String
name: String
}
type StaffBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-04-20 11:11:07 +00:00
staffErrors: [StaffError!]!
2019-08-12 13:07:51 +00:00
}
type StaffCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
staffErrors: [StaffError!]!
2019-08-12 13:07:51 +00:00
user: User
}
input StaffCreateInput {
firstName: String
lastName: String
email: String
isActive: Boolean
note: String
2020-04-20 11:11:07 +00:00
addGroups: [ID!]
2019-09-10 11:28:18 +00:00
redirectUrl: String
2019-08-12 13:07:51 +00:00
}
type StaffDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
staffErrors: [StaffError!]!
2019-08-12 13:07:51 +00:00
user: User
}
2020-04-20 11:11:07 +00:00
type StaffError {
field: String
message: String
code: AccountErrorCode!
permissions: [PermissionEnum!]
groups: [ID!]
users: [ID!]
2019-08-12 13:07:51 +00:00
}
enum StaffMemberStatus {
ACTIVE
DEACTIVATED
}
2020-01-17 15:16:05 +00:00
type StaffNotificationRecipient implements Node {
user: User
active: Boolean
id: ID!
email: String
}
type StaffNotificationRecipientCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2020-01-17 15:16:05 +00:00
staffNotificationRecipient: StaffNotificationRecipient
}
type StaffNotificationRecipientDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2020-01-17 15:16:05 +00:00
staffNotificationRecipient: StaffNotificationRecipient
}
input StaffNotificationRecipientInput {
user: ID
email: String
active: Boolean
}
type StaffNotificationRecipientUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
shopErrors: [ShopError!]!
2020-01-17 15:16:05 +00:00
staffNotificationRecipient: StaffNotificationRecipient
}
2019-08-12 13:07:51 +00:00
type StaffUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
staffErrors: [StaffError!]!
2019-08-12 13:07:51 +00:00
user: User
}
2020-04-20 11:11:07 +00:00
input StaffUpdateInput {
firstName: String
lastName: String
email: String
isActive: Boolean
note: String
addGroups: [ID!]
removeGroups: [ID!]
}
2019-08-12 13:07:51 +00:00
input StaffUserInput {
status: StaffMemberStatus
search: String
}
2020-01-17 15:16:05 +00:00
type Stock implements Node {
warehouse: Warehouse!
productVariant: ProductVariant!
quantity: Int!
id: ID!
2020-04-22 14:41:07 +00:00
quantityAllocated: Int!
2020-01-17 15:16:05 +00:00
}
2019-08-12 13:07:51 +00:00
enum StockAvailability {
IN_STOCK
OUT_OF_STOCK
}
2020-01-17 15:16:05 +00:00
type StockCountableConnection {
pageInfo: PageInfo!
edges: [StockCountableEdge!]!
totalCount: Int
}
type StockCountableEdge {
node: Stock!
cursor: String!
}
2020-03-09 14:59:58 +00:00
type StockError {
field: String
message: String
code: StockErrorCode!
2020-01-17 15:16:05 +00:00
}
2020-03-09 14:59:58 +00:00
enum StockErrorCode {
2020-01-17 15:16:05 +00:00
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input StockFilterInput {
quantity: Float
search: String
}
input StockInput {
warehouse: ID!
quantity: Int
}
2019-08-12 13:07:51 +00:00
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
}
type TaxType {
description: String
taxCode: String
}
type TaxedMoney {
currency: String!
gross: Money!
net: Money!
tax: Money!
}
type TaxedMoneyRange {
start: TaxedMoney
stop: TaxedMoney
}
type Transaction implements Node {
id: ID!
created: DateTime!
payment: Payment!
token: String!
kind: TransactionKind!
isSuccess: Boolean!
error: TransactionError
gatewayResponse: JSONString!
amount: Money
}
enum TransactionError {
TRANSACTIONERROR_INCORRECT_NUMBER
TRANSACTIONERROR_INVALID_NUMBER
TRANSACTIONERROR_INCORRECT_CVV
TRANSACTIONERROR_INVALID_CVV
TRANSACTIONERROR_INCORRECT_ZIP
TRANSACTIONERROR_INCORRECT_ADDRESS
TRANSACTIONERROR_INVALID_EXPIRY_DATE
TRANSACTIONERROR_EXPIRED
TRANSACTIONERROR_PROCESSING_ERROR
TRANSACTIONERROR_DECLINED
}
enum TransactionKind {
AUTH
REFUND
CAPTURE
VOID
2019-08-28 14:53:57 +00:00
CONFIRM
2019-08-12 13:07:51 +00:00
}
2020-04-22 14:41:07 +00:00
union TranslatableItem = ProductTranslatableContent | CollectionTranslatableContent | CategoryTranslatableContent | AttributeTranslatableContent | AttributeValueTranslatableContent | ProductVariantTranslatableContent | PageTranslatableContent | ShippingMethodTranslatableContent | SaleTranslatableContent | VoucherTranslatableContent | MenuItemTranslatableContent
2019-08-12 13:07:51 +00:00
type TranslatableItemConnection {
pageInfo: PageInfo!
edges: [TranslatableItemEdge!]!
totalCount: Int
}
type TranslatableItemEdge {
node: TranslatableItem!
cursor: String!
}
enum TranslatableKinds {
ATTRIBUTE
ATTRIBUTE_VALUE
CATEGORY
COLLECTION
MENU_ITEM
PAGE
PRODUCT
SALE
SHIPPING_METHOD
VARIANT
VOUCHER
}
2020-04-20 11:11:07 +00:00
type TranslationError {
field: String
message: String
code: TranslationErrorCode!
}
enum TranslationErrorCode {
GRAPHQL_ERROR
NOT_FOUND
REQUIRED
}
2019-08-12 13:07:51 +00:00
input TranslationInput {
seoTitle: String
seoDescription: String
name: String
description: String
descriptionJson: JSONString
}
scalar UUID
2020-03-03 11:20:39 +00:00
type UpdateMetadata {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
type UpdatePrivateMetadata {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
metadataErrors: [MetadataError!]!
item: ObjectWithMetadata
}
2019-08-12 13:07:51 +00:00
scalar Upload
2020-03-03 11:20:39 +00:00
type User implements Node & ObjectWithMetadata {
2019-08-12 13:07:51 +00:00
id: ID!
lastLogin: DateTime
email: String!
firstName: String!
lastName: String!
isStaff: Boolean!
isActive: Boolean!
note: String
dateJoined: DateTime!
defaultShippingAddress: Address
defaultBillingAddress: Address
2020-03-03 11:20:39 +00:00
privateMetadata: [MetadataItem]!
metadata: [MetadataItem]!
2020-04-22 14:41:07 +00:00
privateMeta: [MetaStore]! @deprecated(reason: "Use the `privetaMetadata` field. This field will be removed after 2020-07-31.")
meta: [MetaStore]! @deprecated(reason: "Use the `metadata` field. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
addresses: [Address]
checkout: Checkout
2020-04-22 14:41:07 +00:00
giftCards(before: String, after: String, first: Int, last: Int): GiftCardCountableConnection
orders(before: String, after: String, first: Int, last: Int): OrderCountableConnection
permissions: [Permission] @deprecated(reason: "Will be removed in Saleor 2.11.Use the `userPermissions` instead.")
2020-04-20 11:11:07 +00:00
userPermissions: [UserPermission]
permissionGroups: [Group]
editableGroups: [Group]
2019-08-12 13:07:51 +00:00
avatar(size: Int): Image
events: [CustomerEvent]
storedPaymentSources: [PaymentSource]
}
type UserAvatarDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type UserAvatarUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type UserBulkSetActive {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
2019-10-09 06:56:46 +00:00
type UserClearMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
2019-10-09 06:56:46 +00:00
type UserClearPrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
type UserCountableConnection {
pageInfo: PageInfo!
edges: [UserCountableEdge!]!
totalCount: Int
}
type UserCountableEdge {
node: User!
cursor: String!
}
input UserCreateInput {
defaultBillingAddress: AddressInput
defaultShippingAddress: AddressInput
firstName: String
lastName: String
email: String
isActive: Boolean
note: String
2019-09-10 11:28:18 +00:00
redirectUrl: String
2019-08-12 13:07:51 +00:00
}
2020-04-20 11:11:07 +00:00
type UserPermission {
code: PermissionEnum!
name: String!
sourcePermissionGroups(userId: ID!): [Group!]
}
2019-12-17 17:13:56 +00:00
enum UserSortField {
FIRST_NAME
LAST_NAME
EMAIL
ORDER_COUNT
}
input UserSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: UserSortField!
2019-12-17 17:13:56 +00:00
}
2019-08-12 13:07:51 +00:00
type UserUpdateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
type UserUpdatePrivateMeta {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
user: User
}
type VAT {
countryCode: String!
standardRate: Float
reducedRates: [ReducedRate]!
}
type VariantImageAssign {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
image: ProductImage
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type VariantImageUnassign {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
productVariant: ProductVariant
image: ProductImage
2020-03-03 11:20:39 +00:00
productErrors: [ProductError!]!
2019-08-12 13:07:51 +00:00
}
type VariantPricingInfo {
onSale: Boolean
discount: TaxedMoney
discountLocalCurrency: TaxedMoney
price: TaxedMoney
priceUndiscounted: TaxedMoney
priceLocalCurrency: TaxedMoney
}
type VerifyToken {
2020-07-01 11:11:08 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
user: User
2020-07-01 11:11:08 +00:00
isValid: Boolean!
payload: GenericScalar
accountErrors: [AccountError!]!
2019-08-12 13:07:51 +00:00
}
type Voucher implements Node {
id: ID!
name: String
2019-11-27 10:00:36 +00:00
type: VoucherTypeEnum!
2019-08-12 13:07:51 +00:00
code: String!
usageLimit: Int
used: Int!
startDate: DateTime!
endDate: DateTime
applyOncePerOrder: Boolean!
applyOncePerCustomer: Boolean!
discountValueType: DiscountValueTypeEnum!
discountValue: Float!
2019-08-28 14:53:57 +00:00
minSpent: Money
2019-08-12 13:07:51 +00:00
minCheckoutItemsQuantity: Int
2020-04-22 14:41:07 +00:00
categories(before: String, after: String, first: Int, last: Int): CategoryCountableConnection
collections(before: String, after: String, first: Int, last: Int): CollectionCountableConnection
products(before: String, after: String, first: Int, last: Int): ProductCountableConnection
2019-08-12 13:07:51 +00:00
countries: [CountryDisplay]
translation(languageCode: LanguageCodeEnum!): VoucherTranslation
}
type VoucherAddCatalogues {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
voucher: Voucher
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
}
type VoucherBulkDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
count: Int!
2020-04-20 11:11:07 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
}
type VoucherCountableConnection {
pageInfo: PageInfo!
edges: [VoucherCountableEdge!]!
totalCount: Int
}
type VoucherCountableEdge {
node: Voucher!
cursor: String!
}
type VoucherCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
voucher: Voucher
}
type VoucherDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
voucher: Voucher
}
enum VoucherDiscountType {
FIXED
PERCENTAGE
SHIPPING
}
input VoucherFilterInput {
status: [DiscountStatusEnum]
timesUsed: IntRangeInput
discountType: [VoucherDiscountType]
started: DateTimeRangeInput
search: String
}
input VoucherInput {
type: VoucherTypeEnum
name: String
code: String
startDate: DateTime
endDate: DateTime
discountValueType: DiscountValueTypeEnum
discountValue: Decimal
products: [ID]
collections: [ID]
categories: [ID]
minAmountSpent: Decimal
minCheckoutItemsQuantity: Int
countries: [String]
applyOncePerOrder: Boolean
applyOncePerCustomer: Boolean
usageLimit: Int
}
type VoucherRemoveCatalogues {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2019-08-12 13:07:51 +00:00
voucher: Voucher
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
}
2019-12-17 17:13:56 +00:00
enum VoucherSortField {
CODE
START_DATE
END_DATE
VALUE
TYPE
USAGE_LIMIT
MINIMUM_SPENT_AMOUNT
}
input VoucherSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: VoucherSortField!
2019-12-17 17:13:56 +00:00
}
2019-11-27 10:00:36 +00:00
type VoucherTranslatableContent implements Node {
id: ID!
name: String
translation(languageCode: LanguageCodeEnum!): VoucherTranslation
voucher: Voucher
}
2019-08-12 13:07:51 +00:00
type VoucherTranslate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-04-20 11:11:07 +00:00
translationErrors: [TranslationError!]!
2019-08-12 13:07:51 +00:00
voucher: Voucher
}
type VoucherTranslation implements Node {
id: ID!
name: String
language: LanguageDisplay!
}
enum VoucherTypeEnum {
SHIPPING
ENTIRE_ORDER
SPECIFIC_PRODUCT
}
type VoucherUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-23 17:59:10 +00:00
discountErrors: [DiscountError!]!
2019-08-12 13:07:51 +00:00
voucher: Voucher
}
2020-01-17 15:16:05 +00:00
type Warehouse implements Node {
id: ID!
name: String!
2020-03-03 11:20:39 +00:00
slug: String!
2020-01-17 15:16:05 +00:00
companyName: String!
2020-04-22 14:41:07 +00:00
shippingZones(before: String, after: String, first: Int, last: Int): ShippingZoneCountableConnection!
2020-01-17 15:16:05 +00:00
address: Address!
email: String!
}
input WarehouseAddressInput {
streetAddress1: String!
streetAddress2: String
city: String!
cityArea: String
postalCode: String
country: CountryCode!
countryArea: String
phone: String
}
type WarehouseCountableConnection {
pageInfo: PageInfo!
edges: [WarehouseCountableEdge!]!
totalCount: Int
}
type WarehouseCountableEdge {
node: Warehouse!
cursor: String!
}
type WarehouseCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
warehouseErrors: [WarehouseError!]!
2020-01-17 15:16:05 +00:00
warehouse: Warehouse
}
input WarehouseCreateInput {
2020-03-03 11:20:39 +00:00
slug: String
2020-01-17 15:16:05 +00:00
companyName: String
email: String
2020-03-03 11:20:39 +00:00
name: String!
2020-01-17 15:16:05 +00:00
address: WarehouseAddressInput!
2020-03-03 11:20:39 +00:00
shippingZones: [ID]
2020-01-17 15:16:05 +00:00
}
type WarehouseDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
warehouseErrors: [WarehouseError!]!
2020-01-17 15:16:05 +00:00
warehouse: Warehouse
}
type WarehouseError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: WarehouseErrorCode!
2020-01-17 15:16:05 +00:00
}
enum WarehouseErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input WarehouseFilterInput {
search: String
2020-04-20 11:11:07 +00:00
ids: [ID]
2020-01-17 15:16:05 +00:00
}
2020-03-03 11:20:39 +00:00
type WarehouseShippingZoneAssign {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
warehouseErrors: [WarehouseError!]!
2020-07-01 11:11:08 +00:00
warehouse: Warehouse
2020-03-03 11:20:39 +00:00
}
type WarehouseShippingZoneUnassign {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
warehouseErrors: [WarehouseError!]!
2020-07-01 11:11:08 +00:00
warehouse: Warehouse
2020-03-03 11:20:39 +00:00
}
enum WarehouseSortField {
NAME
}
input WarehouseSortingInput {
direction: OrderDirection!
field: WarehouseSortField!
}
2020-01-17 15:16:05 +00:00
type WarehouseUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
warehouseErrors: [WarehouseError!]!
2020-01-17 15:16:05 +00:00
warehouse: Warehouse
}
input WarehouseUpdateInput {
2020-03-03 11:20:39 +00:00
slug: String
2020-01-17 15:16:05 +00:00
companyName: String
email: String
2020-03-03 11:20:39 +00:00
name: String
2020-01-17 15:16:05 +00:00
address: WarehouseAddressInput
}
2019-09-26 15:06:14 +00:00
type Webhook implements Node {
2020-03-03 11:20:39 +00:00
name: String!
2019-09-26 15:06:14 +00:00
targetUrl: String!
isActive: Boolean!
secretKey: String
id: ID!
2020-03-03 11:20:39 +00:00
events: [WebhookEvent!]!
2020-04-22 14:41:07 +00:00
serviceAccount: ServiceAccount! @deprecated(reason: "Use the `app` field instead. This field will be removed after 2020-07-31.")
app: App!
2019-09-26 15:06:14 +00:00
}
type WebhookCountableConnection {
pageInfo: PageInfo!
edges: [WebhookCountableEdge!]!
totalCount: Int
}
type WebhookCountableEdge {
node: Webhook!
cursor: String!
}
type WebhookCreate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
webhookErrors: [WebhookError!]!
2019-09-26 15:06:14 +00:00
webhook: Webhook
}
input WebhookCreateInput {
2019-10-09 06:56:46 +00:00
name: String
2019-09-26 15:06:14 +00:00
targetUrl: String
events: [WebhookEventTypeEnum]
serviceAccount: ID
2020-04-22 14:41:07 +00:00
app: ID
2019-09-26 15:06:14 +00:00
isActive: Boolean
secretKey: String
}
type WebhookDelete {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
webhookErrors: [WebhookError!]!
2020-07-01 11:11:08 +00:00
webhook: Webhook
2019-09-26 15:06:14 +00:00
}
type WebhookError {
field: String
message: String
2020-03-03 11:20:39 +00:00
code: WebhookErrorCode!
2019-09-26 15:06:14 +00:00
}
enum WebhookErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
type WebhookEvent {
2020-03-03 11:20:39 +00:00
eventType: WebhookEventTypeEnum!
name: String!
2019-09-26 15:06:14 +00:00
}
enum WebhookEventTypeEnum {
ANY_EVENTS
2019-09-26 15:06:14 +00:00
ORDER_CREATED
ORDER_FULLY_PAID
ORDER_UPDATED
ORDER_CANCELLED
2019-10-17 15:29:13 +00:00
ORDER_FULFILLED
2019-09-26 15:06:14 +00:00
CUSTOMER_CREATED
PRODUCT_CREATED
2020-01-09 11:13:24 +00:00
CHECKOUT_QUANTITY_CHANGED
2020-03-03 11:20:39 +00:00
FULFILLMENT_CREATED
2019-09-26 15:06:14 +00:00
}
input WebhookFilterInput {
search: String
isActive: Boolean
}
2020-03-03 11:20:39 +00:00
enum WebhookSampleEventTypeEnum {
ORDER_CREATED
ORDER_FULLY_PAID
ORDER_UPDATED
ORDER_CANCELLED
ORDER_FULFILLED
CUSTOMER_CREATED
PRODUCT_CREATED
CHECKOUT_QUANTITY_CHANGED
FULFILLMENT_CREATED
}
2019-12-17 17:13:56 +00:00
enum WebhookSortField {
NAME
SERVICE_ACCOUNT
TARGET_URL
2020-04-22 14:41:07 +00:00
APP
2019-12-17 17:13:56 +00:00
}
input WebhookSortingInput {
direction: OrderDirection!
2020-01-17 15:16:05 +00:00
field: WebhookSortField!
2019-12-17 17:13:56 +00:00
}
2019-09-26 15:06:14 +00:00
type WebhookUpdate {
2020-04-22 14:41:07 +00:00
errors: [Error!]! @deprecated(reason: "Use typed errors with error codes. This field will be removed after 2020-07-31.")
2020-03-03 11:20:39 +00:00
webhookErrors: [WebhookError!]!
2020-07-01 11:11:08 +00:00
webhook: Webhook
2019-09-26 15:06:14 +00:00
}
input WebhookUpdateInput {
2019-10-09 06:56:46 +00:00
name: String
2019-09-26 15:06:14 +00:00
targetUrl: String
events: [WebhookEventTypeEnum]
serviceAccount: ID
2020-04-22 14:41:07 +00:00
app: ID
2019-09-26 15:06:14 +00:00
isActive: Boolean
secretKey: String
}
2019-08-12 13:07:51 +00:00
type Weight {
unit: String!
value: Float!
}
scalar WeightScalar
enum WeightUnitsEnum {
KG
LB
OZ
G
}
2019-10-17 15:29:13 +00:00
scalar _Any
2020-04-22 14:41:07 +00:00
union _Entity = Address | User | Group | ServiceAccount | App | ProductVariant | Product | ProductType | Collection | Category | ProductImage
2019-10-17 15:29:13 +00:00
type _Service {
sdl: String
}