djkato/saleor-dashboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
saleor-dashboard/introspection.json
Paweł Chyła a63af3ab73
Assign channel to permission group (#3515)
2023-08-04 12:42:04 +02:00

130840 lines
3.8 MiB
Raw Permalink Blame History

This file contains ambiguous Unicode characters

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

{
"__schema": {
"queryType": {
"name": "Query"
},
"mutationType": {
"name": "Mutation"
},
"subscriptionType": {
"name": "Subscription"
},
"types": [
{
"kind": "OBJECT",
"name": "AccountAddressCreate",
"description": "Create a new address for the customer. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- ADDRESS_CREATED (async): An address was created.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "address",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance for which the address was created.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountAddressDelete",
"description": "Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.\n\nTriggers the following webhook events:\n- ADDRESS_DELETED (async): An address was deleted.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "address",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance for which the address was deleted.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountAddressUpdate",
"description": "Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.\n\nTriggers the following webhook events:\n- ADDRESS_UPDATED (async): An address was updated.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "address",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user object for which the address was edited.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountChangeEmailRequested",
"description": "Event sent when account change email is requested.\n\nAdded in Saleor 3.15.",
"fields": [
{
"name": "channel",
"description": "The channel data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "newEmail",
"description": "The new email address the user wants to change to.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "The URL to redirect the user after he accepts the request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Shop data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The token required to confirm request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountConfirmationRequested",
"description": "Event sent when account confirmation requested. This event is always sent. enableAccountConfirmationByEmail flag set to True is not required.\n\nAdded in Saleor 3.15.",
"fields": [
{
"name": "channel",
"description": "The channel data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "The URL to redirect the user after he accepts the request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Shop data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The token required to confirm request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountConfirmed",
"description": "Event sent when account is confirmed.\n\nAdded in Saleor 3.15.",
"fields": [
{
"name": "channel",
"description": "The channel data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "The URL to redirect the user after he accepts the request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Shop data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The token required to confirm request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountDelete",
"description": "Remove user account. \n\nRequires one of the following permissions: AUTHENTICATED_USER.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountDeleteRequested",
"description": "Event sent when account delete is requested.\n\nAdded in Saleor 3.15.",
"fields": [
{
"name": "channel",
"description": "The channel data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "The URL to redirect the user after he accepts the request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Shop data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The token required to confirm request.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountError",
"description": "Represents errors in account mutations.",
"fields": [
{
"name": "addressType",
"description": "A type of address that causes the error.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AddressTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AccountErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AccountErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCOUNT_NOT_CONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACTIVATE_OWN_ACCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACTIVATE_SUPERUSER_ACCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DEACTIVATE_OWN_ACCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DEACTIVATE_SUPERUSER_ACCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DELETE_NON_STAFF_USER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DELETE_OWN_ACCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DELETE_STAFF_ACCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DELETE_SUPERUSER_ACCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_CREDENTIALS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_PASSWORD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JWT_DECODE_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JWT_INVALID_CSRF_TOKEN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JWT_INVALID_TOKEN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JWT_MISSING_TOKEN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JWT_SIGNATURE_EXPIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LEFT_NOT_MANAGEABLE_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_CHANNEL_SLUG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_GROUP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_USER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_ENTIRELY_NUMERIC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_RESET_ALREADY_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_TOO_COMMON",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_TOO_SHORT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_TOO_SIMILAR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AccountInput",
"description": "Fields required to update the user.",
"fields": null,
"inputFields": [
{
"name": "defaultBillingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultShippingAddress",
"description": "Shipping address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "Given name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "User language code.",
"type": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "Family name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the user metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountRegister",
"description": "Register a new user.\n\nTriggers the following webhook events:\n- CUSTOMER_CREATED (async): A new customer account was created.\n- NOTIFY_USER (async): A notification for account confirmation.\n- ACCOUNT_CONFIRMATION_REQUESTED (async): An user confirmation was requested. This event is always sent regardless of settings.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiresConfirmation",
"description": "Informs whether users need to confirm their email address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AccountRegisterInput",
"description": "Fields required to create a user.",
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Slug of a channel which will be used to notify users. Optional when only one channel exists.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The email address of the user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "Given name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "User language code.",
"type": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "Family name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "User public metadata.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "password",
"description": "Password.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "Base of frontend URL that will be needed to create confirmation URL.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountRequestDeletion",
"description": "Sends an email with the account removal link for the logged-in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for account delete request.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountSetDefaultAddress",
"description": "Sets a default address for the authenticated user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer's address was updated.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "An updated user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AccountUpdate",
"description": "Updates the account of the logged-in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Address",
"description": "Represents user address data.",
"fields": [
{
"name": "city",
"description": "The city of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cityArea",
"description": "The district of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "companyName",
"description": "Company or organization name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "The country of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryArea",
"description": "The country area of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "The given name of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isDefaultBillingAddress",
"description": "Address is user's default billing address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isDefaultShippingAddress",
"description": "Address is user's default shipping address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "The family name of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.\n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.10.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.10.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "phone",
"description": "The phone number assigned the address.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "postalCode",
"description": "The postal code of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.\n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.10.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.10.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "streetAddress1",
"description": "The first line of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "streetAddress2",
"description": "The second line of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressCreate",
"description": "Creates user address. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- ADDRESS_CREATED (async): A new address was created.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "address",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance for which the address was created.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressCreated",
"description": "Event sent when new address is created.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "address",
"description": "The address the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressDelete",
"description": "Deletes an address. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- ADDRESS_DELETED (async): An address was deleted.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "address",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance for which the address was deleted.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressDeleted",
"description": "Event sent when address is deleted.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "address",
"description": "The address the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "city",
"description": "City.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cityArea",
"description": "District.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "companyName",
"description": "Company or organization.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "Country.",
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryArea",
"description": "State or province.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "Given name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "Family name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Address public metadata.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "phone",
"description": "Phone number.\n\nPhone numbers are validated with Google's [libphonenumber](https://github.com/google/libphonenumber) library.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "postalCode",
"description": "Postal code.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "streetAddress1",
"description": "Address.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "streetAddress2",
"description": "Address.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressSetDefault",
"description": "Sets a default address for the given user. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer was updated.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "An updated user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AddressTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BILLING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressUpdate",
"description": "Updates an address. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- ADDRESS_UPDATED (async): An address was updated.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "address",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user object for which the address was edited.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressUpdated",
"description": "Event sent when address is updated.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "address",
"description": "The address the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AddressValidationData",
"description": "Represents address validation rules for a country.",
"fields": [
{
"name": "addressFormat",
"description": "The address format of the address validation rule.\n\nMany fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows:\n\n- `N`: Name\n- `O`: Organisation\n- `A`: Street Address Line(s)\n- `D`: Dependent locality (may be an inner-city district or a suburb)\n- `C`: City or Locality\n- `S`: Administrative area such as a state, province, island etc\n- `Z`: Zip or postal code\n- `X`: Sorting code\n\n[Click here for more information.](https://github.com/google/libaddressinput/wiki/AddressValidationMetadata)",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addressLatinFormat",
"description": "The latin address format of the address validation rule.\n\nMany fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows:\n\n- `N`: Name\n- `O`: Organisation\n- `A`: Street Address Line(s)\n- `D`: Dependent locality (may be an inner-city district or a suburb)\n- `C`: City or Locality\n- `S`: Administrative area such as a state, province, island etc\n- `Z`: Zip or postal code\n- `X`: Sorting code\n\n[Click here for more information.](https://github.com/google/libaddressinput/wiki/AddressValidationMetadata)",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "allowedFields",
"description": "The allowed fields to use in address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cityAreaChoices",
"description": "The available choices for the city area of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChoiceValue",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cityAreaType",
"description": "The formal name of the city area of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cityChoices",
"description": "The available choices for the city of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChoiceValue",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cityType",
"description": "The formal name of the city of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryAreaChoices",
"description": "The available choices for the country area of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChoiceValue",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryAreaType",
"description": "The formal name of the county area of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "The country code of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryName",
"description": "The country name of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "postalCodeExamples",
"description": "The example postal code of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "postalCodeMatchers",
"description": "The regular expression for postal code validation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "postalCodePrefix",
"description": "The postal code prefix of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "postalCodeType",
"description": "The formal name of the postal code of the address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiredFields",
"description": "The required fields to create a valid address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "upperFields",
"description": "The list of fields that should be in upper case for address validation rule.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Allocation",
"description": "Represents allocation.",
"fields": [
{
"name": "id",
"description": "The ID of allocation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Quantity allocated for orders.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The warehouse were items were allocated.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AllocationStrategyEnum",
"description": "Determine the allocation strategy for the channel.\n\n PRIORITIZE_SORTING_ORDER - allocate stocks according to the warehouses' order\n within the channel\n\n PRIORITIZE_HIGH_STOCK - allocate stock in a warehouse with the most stock\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PRIORITIZE_HIGH_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRIORITIZE_SORTING_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "App",
"description": "Represents app data.",
"fields": [
{
"name": "aboutApp",
"description": "Description of this app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accessToken",
"description": "JWT token used to authenticate by thridparty app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appUrl",
"description": "URL to iframe with the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "author",
"description": "The App's author name.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "brand",
"description": "App's brand data.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppBrand",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "configurationUrl",
"description": "URL to iframe with the configuration for the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `appUrl` instead."
},
{
"name": "created",
"description": "The date and time when the app was created.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dataPrivacy",
"description": "Description of the data privacy defined for this app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead."
},
{
"name": "dataPrivacyUrl",
"description": "URL to details about the privacy policy on the app owner page.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "extensions",
"description": "App's dashboard extensions.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppExtension",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "homepageUrl",
"description": "Homepage of the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if app will be set active or not.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "manifestUrl",
"description": "URL to manifest used during app's installation.\n\nAdded in Saleor 3.5.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of the app's permissions.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Permission",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "supportUrl",
"description": "Support page for the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tokens",
"description": "Last 4 characters of the tokens.\n\nRequires one of the following permissions: MANAGE_APPS, OWNER.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppToken",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Type of the app.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AppTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Version number of the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhooks",
"description": "List of webhooks assigned to this app.\n\nRequires one of the following permissions: MANAGE_APPS, OWNER.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Webhook",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppActivate",
"description": "Activate the app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_STATUS_CHANGED (async): An app was activated.",
"fields": [
{
"name": "app",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppBrand",
"description": "Represents the app's brand data.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "logo",
"description": "App's logos details.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppBrandLogo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppBrandLogo",
"description": "Represents the app's brand logo data.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "default",
"description": "URL to the default logo image.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "ENUM",
"name": "IconThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppCreate",
"description": "Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_INSTALLED (async): An app was installed.",
"fields": [
{
"name": "app",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "authToken",
"description": "The newly created authentication token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppDeactivate",
"description": "Deactivate the app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_STATUS_CHANGED (async): An app was deactivated.",
"fields": [
{
"name": "app",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppDelete",
"description": "Deletes an app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_DELETED (async): An app was deleted.",
"fields": [
{
"name": "app",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppDeleteFailedInstallation",
"description": "Delete failed installation. \n\nRequires one of the following permissions: MANAGE_APPS.",
"fields": [
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "appInstallation",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppDeleted",
"description": "Event sent when app is deleted.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "app",
"description": "The application the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of permissions which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FORBIDDEN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_CUSTOM_HEADERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_MANIFEST_FORMAT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_STATUS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_URL_FORMAT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANIFEST_URL_CANT_CONNECT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_APP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNSUPPORTED_SALEOR_VERSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppExtension",
"description": "Represents app data.",
"fields": [
{
"name": "accessToken",
"description": "JWT token used to authenticate by third-party app extension.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "app",
"description": "The app assigned to app extension.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the app extension.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "label",
"description": "Label of the extension to show in the dashboard.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "mount",
"description": "Place where given extension will be mounted.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppExtensionMountEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of the app extension's permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Permission",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "target",
"description": "Type of way how app extension will be opened.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppExtensionTargetEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL of a view where extension's iframe is placed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppExtensionCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppExtensionCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppExtensionCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppExtension",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppExtensionFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "mount",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppExtensionMountEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "target",
"description": null,
"type": {
"kind": "ENUM",
"name": "AppExtensionTargetEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppExtensionMountEnum",
"description": "All places where app extension can be mounted.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CUSTOMER_DETAILS_MORE_ACTIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_OVERVIEW_CREATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_OVERVIEW_MORE_ACTIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAVIGATION_CATALOG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAVIGATION_CUSTOMERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAVIGATION_DISCOUNTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAVIGATION_ORDERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAVIGATION_PAGES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAVIGATION_TRANSLATIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_DETAILS_MORE_ACTIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_OVERVIEW_CREATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_OVERVIEW_MORE_ACTIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_DETAILS_MORE_ACTIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_OVERVIEW_CREATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_OVERVIEW_MORE_ACTIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppExtensionTargetEnum",
"description": "All available ways of opening an app extension.\n\n POPUP - app's extension will be mounted as a popup window\n APP_PAGE - redirect to app's page\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "APP_PAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "POPUP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppFetchManifest",
"description": "Fetch and validate manifest. \n\nRequires one of the following permissions: MANAGE_APPS.",
"fields": [
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "manifest",
"description": "The validated manifest.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Manifest",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "isActive",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": null,
"type": {
"kind": "ENUM",
"name": "AppTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "name",
"description": "Name of the app.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of permission code names to assign to this app.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppInstall",
"description": "Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.",
"fields": [
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "appInstallation",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppInstallInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "activateAfterInstallation",
"description": "Determine if app will be set active or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appName",
"description": "Name of the app to install.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "manifestUrl",
"description": "URL to app's manifest in JSON format.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of permission code names to assign to this app.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppInstallation",
"description": "Represents ongoing installation of app.",
"fields": [
{
"name": "appName",
"description": "The name of the app installation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "brand",
"description": "App's brand data.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppBrand",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "Created date time of job in ISO 8601 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the app installation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "manifestUrl",
"description": "The URL address of manifest for the app installation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Job message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Job status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "JobStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Date time of job last update in ISO 8601 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Job",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppInstalled",
"description": "Event sent when new app is installed.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "app",
"description": "The application the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppManifestBrand",
"description": "Represents the app's manifest brand data.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "logo",
"description": "App's logos details.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppManifestBrandLogo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppManifestBrandLogo",
"description": "Represents the app's manifest brand data.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "default",
"description": "Data URL with a base64 encoded logo image.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "ENUM",
"name": "IconThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppManifestExtension",
"description": null,
"fields": [
{
"name": "label",
"description": "Label of the extension to show in the dashboard.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "mount",
"description": "Place where given extension will be mounted.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppExtensionMountEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of the app extension's permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Permission",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "target",
"description": "Type of way how app extension will be opened.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppExtensionTargetEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL of a view where extension's iframe is placed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppManifestRequiredSaleorVersion",
"description": null,
"fields": [
{
"name": "constraint",
"description": "Required Saleor version as semver range.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "satisfied",
"description": "Informs if the Saleor version matches the required one.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppManifestWebhook",
"description": null,
"fields": [
{
"name": "asyncEvents",
"description": "The asynchronous events that webhook wants to subscribe.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeAsyncEnum",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the webhook.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "Subscription query of a webhook",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "syncEvents",
"description": "The synchronous events that webhook wants to subscribe.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeSyncEnum",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetUrl",
"description": "The url to receive the payload.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppRetryInstall",
"description": "Retry failed installation of new app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_INSTALLED (async): An app was installed.",
"fields": [
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "appInstallation",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATION_DATE",
"description": "Sort apps by creation date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort apps by name.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort apps.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort apps by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AppSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppStatusChanged",
"description": "Event sent when app status has changed.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "app",
"description": "The application the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppToken",
"description": "Represents token data.",
"fields": [
{
"name": "authToken",
"description": "Last 4 characters of the token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the app token.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the authenticated token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppTokenCreate",
"description": "Creates a new token. \n\nRequires one of the following permissions: MANAGE_APPS.",
"fields": [
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "appToken",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppToken",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "authToken",
"description": "The newly created authentication token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppTokenDelete",
"description": "Deletes an authentication token assigned to app. \n\nRequires one of the following permissions: MANAGE_APPS.",
"fields": [
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "appToken",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppToken",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AppTokenInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "app",
"description": "ID of app.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the token.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppTokenVerify",
"description": "Verify provided app token.",
"fields": [
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valid",
"description": "Determine if token is valid or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AppTypeEnum",
"description": "Enum determining type of your App.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "LOCAL",
"description": "Local Saleor App. The app is fully manageable from dashboard. You can change assigned permissions, add webhooks, or authentication token",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "THIRDPARTY",
"description": "Third party external App. Installation is fully automated. Saleor uses a defined App manifest to gather all required information.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppUpdate",
"description": "Updates an existing app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_UPDATED (async): An app was updated.",
"fields": [
{
"name": "app",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AppUpdated",
"description": "Event sent when app is updated.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "app",
"description": "The application the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AreaUnitsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SQ_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_DM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_FT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_INCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_M",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_MM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_YD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AssignNavigation",
"description": "Assigns storefront's navigation menus. \n\nRequires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "Assigned navigation menu.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AssignedVariantAttribute",
"description": "Represents assigned attribute to variant with variant selection attached.\n\nAdded in Saleor 3.1.",
"fields": [
{
"name": "attribute",
"description": "Attribute assigned to variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantSelection",
"description": "Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric']",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Attribute",
"description": "Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.",
"fields": [
{
"name": "availableInGrid",
"description": "Whether the attribute can be displayed in the admin product list. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "choices",
"description": "List of attribute's values.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for attribute choices.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort attribute choices.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeChoicesSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "entityType",
"description": "The entity type which can be used as a reference.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AttributeEntityTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute. \n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInDashboard",
"description": "Whether the attribute can be filtered in dashboard. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInStorefront",
"description": "Whether the attribute can be filtered in storefront. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "id",
"description": "The ID of the attribute.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inputType",
"description": "The input type to use for entering attribute values in the dashboard.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AttributeInputTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of an attribute displayed in the interface.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypes",
"description": "A list of product types that use this attribute as a product attribute.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductTypeCountableConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantTypes",
"description": "A list of product types that use this attribute as a product variant attribute.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductTypeCountableConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Internal representation of an attribute name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storefrontSearchPosition",
"description": "The position of the attribute in the storefront navigation (0 by default). Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "translation",
"description": "Returns translated attribute fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The attribute type.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AttributeTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unit",
"description": "The unit of attribute values.",
"args": [],
"type": {
"kind": "ENUM",
"name": "MeasurementUnitsEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueRequired",
"description": "Whether the attribute requires values to be passed or not. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInStorefront",
"description": "Whether the attribute should be visible or not in storefront. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "withChoices",
"description": "Flag indicating that attribute has predefined choices.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeBulkCreate",
"description": "Creates attributes.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nTriggers the following webhook events:\n- ATTRIBUTE_CREATED (async): An attribute was created.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeBulkCreateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the created attributes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeBulkCreateResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeBulkCreateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeBulkCreateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeBulkCreateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BLANK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAX_LENGTH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeBulkCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "entityType",
"description": "The entity type which can be used as a reference.",
"type": {
"kind": "ENUM",
"name": "AttributeEntityTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInDashboard",
"description": "Whether the attribute can be filtered in dashboard.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inputType",
"description": "The input type to use for entering attribute values in the dashboard.",
"type": {
"kind": "ENUM",
"name": "AttributeInputTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isVariantOnly",
"description": "Whether the attribute is for variants only.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of an attribute displayed in the interface.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Internal representation of an attribute name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The attribute type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unit",
"description": "The unit of attribute values.",
"type": {
"kind": "ENUM",
"name": "MeasurementUnitsEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueRequired",
"description": "Whether the attribute requires values to be passed or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute's values.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeBulkCreateValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInStorefront",
"description": "Whether the attribute should be visible or not in storefront.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeBulkCreateResult",
"description": null,
"fields": [
{
"name": "attribute",
"description": "Attribute data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": "List of errors occurred on create attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeBulkCreateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeBulkCreateValueInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "contentType",
"description": "File content type.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute value.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fileUrl",
"description": "URL of the file attribute. Every time, a new value is created.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of a value displayed in the interface.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Represent value of the attribute value (e.g. color values for swatch attributes).",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeBulkDelete",
"description": "Deletes attributes. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_DELETED (async): An attribute was deleted.",
"fields": [
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeBulkTranslate",
"description": "Creates/updates translations for attributes.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "count",
"description": "Returns how many translations were created/updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeBulkTranslateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the translations.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeBulkTranslateResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeBulkTranslateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeTranslateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeBulkTranslateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "externalReference",
"description": "External reference of an attribute.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Attribute ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationFields",
"description": "Translation fields.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeBulkTranslateResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on translation attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeBulkTranslateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Attribute translation data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeChoicesSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort attribute choice by name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SLUG",
"description": "Sort attribute choice by slug.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeChoicesSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort attribute choices.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort attribute choices by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeChoicesSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeCreate",
"description": "Creates an attribute.\n\nTriggers the following webhook events:\n- ATTRIBUTE_CREATED (async): An attribute was created.",
"fields": [
{
"name": "attribute",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "availableInGrid",
"description": "Whether the attribute can be displayed in the admin product list.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "entityType",
"description": "The entity type which can be used as a reference.",
"type": {
"kind": "ENUM",
"name": "AttributeEntityTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInDashboard",
"description": "Whether the attribute can be filtered in dashboard.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInStorefront",
"description": "Whether the attribute can be filtered in storefront.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inputType",
"description": "The input type to use for entering attribute values in the dashboard.",
"type": {
"kind": "ENUM",
"name": "AttributeInputTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isVariantOnly",
"description": "Whether the attribute is for variants only.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of an attribute displayed in the interface.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Internal representation of an attribute name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storefrontSearchPosition",
"description": "The position of the attribute in the storefront navigation (0 by default).\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The attribute type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unit",
"description": "The unit of attribute values.",
"type": {
"kind": "ENUM",
"name": "MeasurementUnitsEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueRequired",
"description": "Whether the attribute requires values to be passed or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute's values.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueCreateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInStorefront",
"description": "Whether the attribute should be visible or not in storefront.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeCreated",
"description": "Event sent when new attribute is created.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "attribute",
"description": "The attribute the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeDelete",
"description": "Deletes an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_DELETED (async): An attribute was deleted.",
"fields": [
{
"name": "attribute",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeDeleted",
"description": "Event sent when attribute is deleted.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "attribute",
"description": "The attribute the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeEntityTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeEntityTypeEnumFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "eq",
"description": "The value equal to.",
"type": {
"kind": "ENUM",
"name": "AttributeEntityTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneOf",
"description": "The value included in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeEntityTypeEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "availableInGrid",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Specifies the channel by which the data should be filtered. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInDashboard",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInStorefront",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inCategory",
"description": null,
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inCollection",
"description": null,
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isVariantOnly",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": null,
"type": {
"kind": "ENUM",
"name": "AttributeTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueRequired",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInStorefront",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "boolean",
"description": "The boolean value of the attribute.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "The date range that the returned values should be in. In case of date/time attributes, the UTC midnight of the given date is used.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dateTime",
"description": "The date/time range that the returned values should be in.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Internal representation of an attribute name.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "Internal representation of a value (unique per attribute).",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valuesRange",
"description": "The range that the returned values should be in.",
"type": {
"kind": "INPUT_OBJECT",
"name": "IntRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeInputTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BOOLEAN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DATE_TIME",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DROPDOWN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FILE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MULTISELECT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NUMERIC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PLAIN_TEXT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFERENCE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RICH_TEXT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SWATCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeInputTypeEnumFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "eq",
"description": "The value equal to.",
"type": {
"kind": "ENUM",
"name": "AttributeInputTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneOf",
"description": "The value included in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeInputTypeEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeReorderValues",
"description": "Reorder the values of an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"fields": [
{
"name": "attribute",
"description": "Attribute from which values are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AVAILABLE_IN_GRID",
"description": "Sort attributes based on whether they can be displayed or not in a product grid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FILTERABLE_IN_DASHBOARD",
"description": "Sort attributes by the filterable in dashboard flag",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FILTERABLE_IN_STOREFRONT",
"description": "Sort attributes by the filterable in storefront flag",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS_VARIANT_ONLY",
"description": "Sort attributes by the variant only flag",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort attributes by name",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SLUG",
"description": "Sort attributes by slug",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STOREFRONT_SEARCH_POSITION",
"description": "Sort attributes by their position in storefront",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VALUE_REQUIRED",
"description": "Sort attributes by the value required flag",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VISIBLE_IN_STOREFRONT",
"description": "Sort attributes by visibility in the storefront",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort attributes.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort attributes by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeTranslatableContent",
"description": null,
"fields": [
{
"name": "attribute",
"description": "Custom attribute of a product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "id",
"description": "The ID of the attribute.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the attribute to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated attribute fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeTranslate",
"description": "Creates/updates translations for an attribute. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "attribute",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeTranslateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeTranslation",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the attribute translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated attribute name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PAGE_TYPE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_TYPE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeTypeEnumFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "eq",
"description": "The value equal to.",
"type": {
"kind": "ENUM",
"name": "AttributeTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneOf",
"description": "The value included in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeTypeEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeUpdate",
"description": "Updates attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"fields": [
{
"name": "attribute",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addValues",
"description": "New values to be created for this attribute.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueUpdateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableInGrid",
"description": "Whether the attribute can be displayed in the admin product list.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInDashboard",
"description": "Whether the attribute can be filtered in dashboard.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInStorefront",
"description": "Whether the attribute can be filtered in storefront.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isVariantOnly",
"description": "Whether the attribute is for variants only.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of an attribute displayed in the interface.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeValues",
"description": "IDs of values to be removed from this attribute.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Internal representation of an attribute name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storefrontSearchPosition",
"description": "The position of the attribute in the storefront navigation (0 by default).\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unit",
"description": "The unit of attribute values.",
"type": {
"kind": "ENUM",
"name": "MeasurementUnitsEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueRequired",
"description": "Whether the attribute requires values to be passed or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInStorefront",
"description": "Whether the attribute should be visible or not in storefront.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeUpdated",
"description": "Event sent when attribute is updated.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "attribute",
"description": "The attribute the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValue",
"description": "Represents a value of an attribute.",
"fields": [
{
"name": "boolean",
"description": "Represents the boolean value of the attribute value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "Represents the date value of the attribute value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dateTime",
"description": "Represents the date/time value of the attribute value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute value. \n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "file",
"description": "Represents file URL and content type (if attribute value is a file).",
"args": [],
"type": {
"kind": "OBJECT",
"name": "File",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the attribute value.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inputType",
"description": "The input type to use for entering attribute values in the dashboard.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AttributeInputTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of a value displayed in the interface.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Represents the text of the attribute value, plain text without formating.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reference",
"description": "The ID of the attribute reference.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Represents the text of the attribute value, includes formatting.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Internal representation of a value (unique per attribute).",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated attribute value fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for attribute value.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Represent value of the attribute value (e.g. color values for swatch attributes).",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueBulkDelete",
"description": "Deletes values of attributes. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"fields": [
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueBulkTranslate",
"description": "Creates/updates translations for attributes values.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "count",
"description": "Returns how many translations were created/updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValueBulkTranslateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the translations.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValueBulkTranslateResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueBulkTranslateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AttributeValueTranslateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeValueBulkTranslateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "externalReference",
"description": "External reference of an attribute value.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Attribute value ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationFields",
"description": "Translation fields.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueBulkTranslateResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on translation attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValueBulkTranslateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Attribute value translation data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValueTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValueCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueCreate",
"description": "Creates a value for an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_CREATED (async): An attribute value was created.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"fields": [
{
"name": "attribute",
"description": "The updated attribute.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "attributeValue",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeValueCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "contentType",
"description": "File content type.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute value.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fileUrl",
"description": "URL of the file attribute. Every time, a new value is created.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of a value displayed in the interface.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Represents the text of the attribute value, plain text without formating.\n\nDEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Represents the text of the attribute value, includes formatting.\n\nRich text format. For reference see https://editorjs.io/\n\nDEPRECATED: this field will be removed in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Represent value of the attribute value (e.g. color values for swatch attributes).",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueCreated",
"description": "Event sent when new attribute value is created.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "attributeValue",
"description": "The attribute value the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueDelete",
"description": "Deletes a value of an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"fields": [
{
"name": "attribute",
"description": "The updated attribute.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "attributeValue",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueDeleted",
"description": "Event sent when attribute value is deleted.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "attributeValue",
"description": "The attribute value the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeValueFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "boolean",
"description": "Represents the boolean value of the attribute value.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "contentType",
"description": "File content type.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "Represents the date value of the attribute value.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dateTime",
"description": "Represents the date/time value of the attribute value.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dropdown",
"description": "Attribute value ID or external reference.\n\nAdded in Saleor 3.9.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueSelectableTypeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "file",
"description": "URL of the file attribute. Every time, a new value is created.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the selected attribute.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "multiselect",
"description": "List of attribute value IDs or external references.\n\nAdded in Saleor 3.9.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueSelectableTypeInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "numeric",
"description": "Numeric value of an attribute.\n\nAdded in Saleor 3.9.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Plain text content.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "references",
"description": "List of entity IDs that will be used as references.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Text content in JSON format.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "swatch",
"description": "Attribute value ID or external reference.\n\nAdded in Saleor 3.9.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueSelectableTypeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. This field will be removed in Saleor 4.0.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeValueSelectableTypeInput",
"description": "Represents attribute value.\n1. If ID is provided, then attribute value will be resolved by ID.\n2. If externalReference is provided, then attribute value will be resolved by external reference.\n3. If value is provided, then attribute value will be resolved by value. If this attribute value doesn't exist, then it will be created.\n4. If externalReference and value is provided then new attribute value will be created.\n\nAdded in Saleor 3.9.",
"fields": null,
"inputFields": [
{
"name": "externalReference",
"description": "External reference of an attribute value.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of an attribute value.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueTranslatableContent",
"description": null,
"fields": [
{
"name": "attribute",
"description": "Associated attribute that can be translated.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeTranslatableContent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeValue",
"description": "Represents a value of an attribute.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "id",
"description": "The ID of the attribute value translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the attribute value to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Attribute plain text value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Attribute value.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated attribute value fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for attribute value.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueTranslate",
"description": "Creates/updates translations for an attribute value. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "attributeValue",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "AttributeValueTranslateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueTranslation",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the attribute value translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated attribute value name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Translated plain text attribute value .",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Translated rich-text attribute value.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeValueTranslationInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "name",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Translated text.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Translated text.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueUpdate",
"description": "Updates value of an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"fields": [
{
"name": "attribute",
"description": "The updated attribute.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "attributeValue",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeValueUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "contentType",
"description": "File content type.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute value.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fileUrl",
"description": "URL of the file attribute. Every time, a new value is created.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of a value displayed in the interface.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Represents the text of the attribute value, plain text without formating.\n\nDEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Represents the text of the attribute value, includes formatting.\n\nRich text format. For reference see https://editorjs.io/\n\nDEPRECATED: this field will be removed in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Represent value of the attribute value (e.g. color values for swatch attributes).",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "AttributeValueUpdated",
"description": "Event sent when attribute value is updated.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "attributeValue",
"description": "The attribute value the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "AttributeWhereInput",
"description": "Where filtering options.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": null,
"inputFields": [
{
"name": "AND",
"description": "List of conditions that must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OR",
"description": "A list of conditions of which at least one must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "entityType",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeEntityTypeEnumFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filterableInDashboard",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inCategory",
"description": null,
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inCollection",
"description": null,
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inputType",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeInputTypeEnumFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "StringFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "StringFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeTypeEnumFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unit",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "MeasurementUnitsEnumFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueRequired",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInStorefront",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "withChoices",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Boolean",
"description": "The `Boolean` scalar type represents `true` or `false`.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "BulkAttributeValueInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "boolean",
"description": "The boolean value of an attribute to resolve. If the passed value is non-existent, it will be created.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "contentType",
"description": "File content type.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "Represents the date value of the attribute value.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dateTime",
"description": "Represents the date/time value of the attribute value.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dropdown",
"description": "Attribute value ID.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueSelectableTypeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this attribute.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "file",
"description": "URL of the file attribute. Every time, a new value is created.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the selected attribute.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "multiselect",
"description": "List of attribute value IDs.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueSelectableTypeInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "numeric",
"description": "Numeric value of an attribute.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plainText",
"description": "Plain text content.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "references",
"description": "List of entity IDs that will be used as references.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "richText",
"description": "Text content in JSON format.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "swatch",
"description": "Attribute value ID.\n\nAdded in Saleor 3.12.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueSelectableTypeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.This field will be removed in Saleor 4.0.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkProductError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": "List of channel IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "index",
"description": "Index of an input list item that caused the error.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouse IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "BulkStockError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "index",
"description": "Index of an input list item that caused the error.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CalculateTaxes",
"description": "Synchronous webhook for calculating checkout/order taxes.\n\nAdded in Saleor 3.7.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxBase",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxableObject",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CardInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "code",
"description": "Payment method nonce, a token returned by the appropriate provider's SDK.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cvc",
"description": "Card security code.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "money",
"description": "Information about currency and amount.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CatalogueInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "categories",
"description": "Categories related to the discount.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "Collections related to the discount.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "Products related to the discount.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "Product variant related to the discount.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Category",
"description": "Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront.",
"fields": [
{
"name": "ancestors",
"description": "List of ancestors of the category.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "backgroundImage",
"description": "Background image of the category.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "children",
"description": "List of children of the category.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the category.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Description of the category.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the category.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "level",
"description": "Level of the category.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of category",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "parent",
"description": "Parent category.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products in the category. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for products.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort products.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductOrder",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": "Filtering options for products.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "SEO description of category.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "SEO title of category.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the category.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated category fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for category.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryBulkDelete",
"description": "Deletes categories. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CategoryCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryCreate",
"description": "Creates a new category. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "category",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryCreated",
"description": "Event sent when new category is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "category",
"description": "The category the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryDelete",
"description": "Deletes a category. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "category",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryDeleted",
"description": "Event sent when category is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "category",
"description": "The category the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CategoryFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CategoryInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "backgroundImage",
"description": "Background image file.",
"type": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "backgroundImageAlt",
"description": "Alt text for a product media.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Category description.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the category metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Category name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the category private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Category slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CategorySortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort categories by name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_COUNT",
"description": "Sort categories by product count.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SUBCATEGORY_COUNT",
"description": "Sort categories by subcategory count.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CategorySortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Specifies the channel in which to sort the data.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "direction",
"description": "Specifies the direction in which to sort categories.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort categories by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CategorySortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryTranslatableContent",
"description": null,
"fields": [
{
"name": "category",
"description": "Represents a single category of products.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "description",
"description": "Category description to translate.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Description of the category.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the category translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the category translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "SEO description to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "SEO title to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated category fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for category.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryTranslate",
"description": "Creates/updates translations for a category. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "category",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryTranslation",
"description": null,
"fields": [
{
"name": "description",
"description": "Translated description of the category.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Translated description of the category.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the category translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated category name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "Translated SEO description.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "Translated SEO title.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryUpdate",
"description": "Updates a category. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "category",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CategoryUpdated",
"description": "Event sent when category is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "category",
"description": "The category the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CategoryWhereInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "AND",
"description": "List of conditions that must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CategoryWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OR",
"description": "A list of conditions of which at least one must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CategoryWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Channel",
"description": "Represents channel.",
"fields": [
{
"name": "availableShippingMethodsPerCountry",
"description": "Shipping methods that are available for the channel.\n\nAdded in Saleor 3.6.",
"args": [
{
"name": "countries",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethodsPerCountry",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "List of shippable countries for the channel.\n\nAdded in Saleor 3.6.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currencyCode",
"description": "A currency that is assigned to the channel.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultCountry",
"description": "Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasOrders",
"description": "Whether a channel has associated orders.\n\nRequires one of the following permissions: MANAGE_CHANNELS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Whether the channel is active.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.\n\nAdded in Saleor 3.15.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.15.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.15.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the channel.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderSettings",
"description": "Channel-specific order settings.\n\nAdded in Saleor 3.12.\n\nRequires one of the following permissions: MANAGE_CHANNELS, MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderSettings",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.\n\nAdded in Saleor 3.15.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.15.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.15.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockSettings",
"description": "Define the stock setting for this channel.\n\nAdded in Saleor 3.7.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StockSettings",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouses assigned to this channel.\n\nAdded in Saleor 3.5.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelActivate",
"description": "Activate a channel. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_STATUS_CHANGED (async): A channel was activated.",
"fields": [
{
"name": "channel",
"description": "Activated channel.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelCreate",
"description": "Creates new channel. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_CREATED (async): A channel was created.",
"fields": [
{
"name": "channel",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ChannelCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addShippingZones",
"description": "List of shipping zones to assign to the channel.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addWarehouses",
"description": "List of warehouses to assign to the channel.\n\nAdded in Saleor 3.5.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currencyCode",
"description": "Currency of the channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultCountry",
"description": "Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if channel will be set active or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Channel public metadata.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderSettings",
"description": "The channel order settings\n\nAdded in Saleor 3.12.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Channel private metadata.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockSettings",
"description": "The channel stock settings.\n\nAdded in Saleor 3.7.",
"type": {
"kind": "INPUT_OBJECT",
"name": "StockSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelCreated",
"description": "Event sent when new channel is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "channel",
"description": "The channel the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelDeactivate",
"description": "Deactivate a channel. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_STATUS_CHANGED (async): A channel was deactivated.",
"fields": [
{
"name": "channel",
"description": "Deactivated channel.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelDelete",
"description": "Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_DELETED (async): A channel was deleted.",
"fields": [
{
"name": "channel",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ChannelDeleteInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channelId",
"description": "ID of channel to migrate orders from origin channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelDeleted",
"description": "Event sent when channel is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "channel",
"description": "The channel the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ChannelErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZones",
"description": "List of shipping zone IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouses IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ChannelErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNELS_CURRENCY_MUST_BE_THE_SAME",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_WITH_ORDERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ChannelListingUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channelListing",
"description": "ID of a channel listing.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "costPrice",
"description": "Cost price of the variant in channel.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorderThreshold",
"description": "The threshold for preorder variant in channel.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Price of the particular variant in channel.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelMetadataUpdated",
"description": "Event sent when channel metadata is updated.\n\nAdded in Saleor 3.15.",
"fields": [
{
"name": "channel",
"description": "The channel the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelReorderWarehouses",
"description": "Reorder the warehouses of a channel.\n\nAdded in Saleor 3.7. \n\nRequires one of the following permissions: MANAGE_CHANNELS.",
"fields": [
{
"name": "channel",
"description": "Channel within the warehouses are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelStatusChanged",
"description": "Event sent when channel status has changed.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "channel",
"description": "The channel the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelUpdate",
"description": "Update a channel.\n\nRequires one of the following permissions: MANAGE_CHANNELS.\nRequires one of the following permissions when updating only orderSettings field: MANAGE_CHANNELS, MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- CHANNEL_UPDATED (async): A channel was updated.\n- CHANNEL_METADATA_UPDATED (async): Optionally triggered when public or private metadata is updated.",
"fields": [
{
"name": "channel",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ChannelError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ChannelUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addShippingZones",
"description": "List of shipping zones to assign to the channel.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addWarehouses",
"description": "List of warehouses to assign to the channel.\n\nAdded in Saleor 3.5.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultCountry",
"description": "Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if channel will be set active or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Channel public metadata.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the channel.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderSettings",
"description": "The channel order settings\n\nAdded in Saleor 3.12.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Channel private metadata.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeShippingZones",
"description": "List of shipping zones to unassign from the channel.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeWarehouses",
"description": "List of warehouses to unassign from the channel.\n\nAdded in Saleor 3.5.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the channel.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockSettings",
"description": "The channel stock settings.\n\nAdded in Saleor 3.7.",
"type": {
"kind": "INPUT_OBJECT",
"name": "StockSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChannelUpdated",
"description": "Event sent when channel is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "channel",
"description": "The channel the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Checkout",
"description": "Checkout object.",
"fields": [
{
"name": "authorizeStatus",
"description": "The authorize status of the checkout.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutAuthorizeStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableCollectionPoints",
"description": "Collection points that can be used for this order.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availablePaymentGateways",
"description": "List of available payment gateways.\n\nTriggers the following webhook events:\n- PAYMENT_LIST_GATEWAYS (sync): Fetch payment gateways available for checkout.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentGateway",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableShippingMethods",
"description": "Shipping methods that can be used with this checkout.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `shippingMethods` instead."
},
{
"name": "billingAddress",
"description": "The billing address of the checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "The channel for which checkout was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeStatus",
"description": "The charge status of the checkout.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutChargeStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": "The date and time when the checkout was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deliveryMethod",
"description": "The delivery method selected for this checkout.\n\nAdded in Saleor 3.1.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.",
"args": [],
"type": {
"kind": "UNION",
"name": "DeliveryMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discount",
"description": "The total discount applied to the checkout. Note: Only discount created via voucher are included in this field.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountName",
"description": "The name of voucher assigned to the checkout.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Determines whether checkout prices should include taxes when displayed in a storefront.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email of a customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCards",
"description": "List of gift cards associated with this checkout.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the checkout.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isShippingRequired",
"description": "Returns True, if checkout requires shipping.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Checkout language code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastChange",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `updatedAt` instead."
},
{
"name": "lines",
"description": "A list of checkout lines, each containing information about an item in the checkout.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutLine",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "The note for the checkout.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of items purchased.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "The shipping address of the checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "The shipping method related with checkout.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `deliveryMethod` instead."
},
{
"name": "shippingMethods",
"description": "Shipping methods that can be used with this checkout.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPrice",
"description": "The price of the shipping, with all the taxes included. Set to 0 when no delivery method is selected.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockReservationExpires",
"description": "Date when oldest stock reservation for this checkout expires or null if no stock is reserved.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subtotalPrice",
"description": "The price of the checkout before shipping, with taxes included.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxExemption",
"description": "Returns True if checkout has to be exempt from taxes.\n\nAdded in Saleor 3.8.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The checkout's token.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalBalance",
"description": "The difference between the paid and the checkout total amount.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPrice",
"description": "The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactions",
"description": "List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedDiscountName",
"description": "Translation of the discountName field in the language set in Checkout.languageCode field.Note: this field is set automatically when Checkout.languageCode is defined; otherwise it's null",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Time of last modification of the given checkout.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user assigned to the checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherCode",
"description": "The code of voucher assigned to the checkout.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutAddPromoCode",
"description": "Adds a gift card or a voucher to a checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "The checkout with the added gift card or voucher.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CheckoutAddressValidationRules",
"description": null,
"fields": null,
"inputFields": [
{
"name": "checkFieldsFormat",
"description": "Determines if an error should be raised when the provided address doesn't match the expected format. Example: using letters for postal code when the numbers are expected.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkRequiredFields",
"description": "Determines if an error should be raised when the provided address doesn't have all the required fields. The list of required fields is dynamic and depends on the country code (use the `addressValidationRules` query to fetch them). Note: country code is mandatory for all addresses regardless of the rules provided in this input.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "enableFieldsNormalization",
"description": "Determines if Saleor should apply normalization on address fields. Example: converting city field to uppercase letters.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true",
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CheckoutAuthorizeStatusEnum",
"description": "Determine a current authorize status for checkout.\n\n We treat the checkout as fully authorized when the sum of authorized and charged\n funds cover the checkout.total.\n We treat the checkout as partially authorized when the sum of authorized and charged\n funds covers only part of the checkout.total\n We treat the checkout as not authorized when the sum of authorized and charged funds\n is 0.\n\n NONE - the funds are not authorized\n PARTIAL - the cover funds don't cover fully the checkout's total\n FULL - the cover funds covers the checkout's total\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FULL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NONE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutBillingAddressUpdate",
"description": "Update billing address in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CheckoutChargeStatusEnum",
"description": "Determine the current charge status for the checkout.\n\n The checkout is considered overcharged when the sum of the transactionItem's charge\n amounts exceeds the value of `checkout.total`.\n If the sum of the transactionItem's charge amounts equals\n `checkout.total`, we consider the checkout to be fully charged.\n If the sum of the transactionItem's charge amounts covers a part of the\n `checkout.total`, we treat the checkout as partially charged.\n\n\n NONE - the funds are not charged.\n PARTIAL - the funds that are charged don't cover the checkout's total\n FULL - the funds that are charged fully cover the checkout's total\n OVERCHARGED - the charged funds are bigger than checkout's total\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FULL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NONE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OVERCHARGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutComplete",
"description": "Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.\n- ORDER_CREATED (async): Triggered when order is created.\n- NOTIFY_USER (async): A notification for order placement.\n- NOTIFY_USER (async): A staff notification for order placement.\n- ORDER_UPDATED (async): Triggered when order received the update after placement.\n- ORDER_PAID (async): Triggered when newly created order is paid.\n- ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.\n- ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.",
"fields": [
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "confirmationData",
"description": "Confirmation data used to process additional authorization steps.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "confirmationNeeded",
"description": "Set to true if payment needs to be confirmed before checkout is complete.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Placed order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCreate",
"description": "Create a new checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_CREATED (async): A checkout was created.",
"fields": [
{
"name": "checkout",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "created",
"description": "Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Always returns `true`."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCreateFromOrder",
"description": "Create new checkout from existing order.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "checkout",
"description": "Created checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutCreateFromOrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unavailableVariants",
"description": "Variants that were not attached to the checkout.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutCreateFromOrderUnavailableVariant",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCreateFromOrderError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutCreateFromOrderErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CheckoutCreateFromOrderErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CHANNEL_INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAX_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCreateFromOrderUnavailableVariant",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutCreateFromOrderUnavailableVariantErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineId",
"description": "Order line ID that is unavailable.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "Variant ID that is unavailable.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CheckoutCreateFromOrderUnavailableVariantErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INSUFFICIENT_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_NOT_PUBLISHED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_UNAVAILABLE_FOR_PURCHASE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QUANTITY_GREATER_THAN_LIMIT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNAVAILABLE_VARIANT_IN_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CheckoutCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "billingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel in which to create a checkout.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The customer's email address.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Checkout language code.",
"type": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "A list of checkout lines, each containing information about an item in the checkout.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CheckoutLineInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "validationRules",
"description": "The checkout validation rules that can be changed.\n\nAdded in Saleor 3.5.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CheckoutValidationRules",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCreated",
"description": "Event sent when new checkout is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "checkout",
"description": "The checkout the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCustomerAttach",
"description": "Sets the customer as the owner of the checkout. \n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutCustomerDetach",
"description": "Removes the user assigned as the owner of the checkout. \n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutDeliveryMethodUpdate",
"description": "Updates the delivery method (shipping method or pick up point) of the checkout.\n\nAdded in Saleor 3.1.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one.\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutEmailUpdate",
"description": "Updates email address in the existing checkout object.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutError",
"description": null,
"fields": [
{
"name": "addressType",
"description": "A type of address that causes the error.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AddressTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of line Ids which cause the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "List of varint IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CheckoutErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BILLING_ADDRESS_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_NOT_FULLY_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DELIVERY_METHOD_NOT_APPLICABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_NOT_APPLICABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INACTIVE_PAYMENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INSUFFICIENT_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_SHIPPING_METHOD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_CHANNEL_SLUG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_LINES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_NOT_PUBLISHED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_UNAVAILABLE_FOR_PURCHASE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QUANTITY_GREATER_THAN_LIMIT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ADDRESS_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_METHOD_NOT_APPLICABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_METHOD_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_NOT_REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAX_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNAVAILABLE_VARIANT_IN_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_NOT_APPLICABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZERO_QUANTITY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CheckoutFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "authorizeStatus",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutAuthorizeStatusEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeStatus",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutChargeStatusEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customer",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutFilterShippingMethods",
"description": "Filter shipping methods for checkout.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "checkout",
"description": "The checkout the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethods",
"description": "Shipping methods that can be used with this checkout.\n\nAdded in Saleor 3.6.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutFullyPaid",
"description": "Event sent when checkout is fully paid with transactions.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "checkout",
"description": "The checkout the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLanguageCodeUpdate",
"description": "Update language code in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLine",
"description": "Represents an item in the checkout.",
"fields": [
{
"name": "id",
"description": "The ID of the checkout line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.\n\nAdded in Saleor 3.5.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.\n\nAdded in Saleor 3.5.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The quantity of product variant assigned to the checkout line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiresShipping",
"description": "Indicates whether the item need to be delivered.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPrice",
"description": "The sum of the checkout line price, taxes and discounts.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "undiscountedTotalPrice",
"description": "The sum of the checkout line price, without discounts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "undiscountedUnitPrice",
"description": "The unit price of the checkout line, without discounts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitPrice",
"description": "The unit price of the checkout line, with taxes and discounts.\n\nTriggers the following webhook events:\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variant",
"description": "The product variant from which the checkout line was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLineCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutLineCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLineCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutLine",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLineDelete",
"description": "Deletes a CheckoutLine.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CheckoutLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "forceNewLine",
"description": "Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. \n\nAdded in Saleor 3.6.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the object's metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of items purchased.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of the product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CheckoutLineUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "lineId",
"description": "ID of the line.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of items purchased. Optional for apps, required for any other users.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of the product variant. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `lineId` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLinesAdd",
"description": "Adds a checkout line to the existing checkout.If line was already in checkout, its quantity will be increased.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLinesDelete",
"description": "Deletes checkout lines.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutLinesUpdate",
"description": "Updates checkout line in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutMetadataUpdated",
"description": "Event sent when checkout metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "checkout",
"description": "The checkout the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutPaymentCreate",
"description": "Create a new payment for given checkout.",
"fields": [
{
"name": "checkout",
"description": "Related checkout object.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "A newly created payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutRemovePromoCode",
"description": "Remove a gift card or a voucher from a checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "The checkout with the removed gift card or voucher.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutShippingAddressUpdate",
"description": "Update shipping address in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutShippingMethodUpdate",
"description": "Updates the shipping method of the checkout.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout shipping method with the external one.\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"fields": [
{
"name": "checkout",
"description": "An updated checkout.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CheckoutSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATION_DATE",
"description": "Sort checkouts by creation date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER",
"description": "Sort checkouts by customer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT",
"description": "Sort checkouts by payment.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CheckoutSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort checkouts.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort checkouts by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CheckoutSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CheckoutUpdated",
"description": "Event sent when checkout is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "checkout",
"description": "The checkout the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CheckoutValidationRules",
"description": null,
"fields": null,
"inputFields": [
{
"name": "billingAddress",
"description": "The validation rules that can be applied to provided billing address data.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CheckoutAddressValidationRules",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "The validation rules that can be applied to provided shipping address data.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CheckoutAddressValidationRules",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ChoiceValue",
"description": null,
"fields": [
{
"name": "raw",
"description": "The raw name of the choice.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "verbose",
"description": "The verbose name of the choice.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Collection",
"description": "Represents a collection of products.",
"fields": [
{
"name": "backgroundImage",
"description": "Background image of the collection.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Channel given to retrieve this collection. Also used by federation gateway to resolve this object in a federated query.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of channels in which the collection is available.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionChannelListing",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the collection.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Description of the collection.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products in this collection.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for products.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort products.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductOrder",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": "Filtering options for products.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "SEO description of the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "SEO title of the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the collection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated collection fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionAddProducts",
"description": "Adds products to a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collection",
"description": "Collection to which products will be added.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionBulkDelete",
"description": "Deletes collections. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collectionErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionChannelListing",
"description": "Represents collection channel listing.",
"fields": [
{
"name": "channel",
"description": "The channel to which the collection belongs.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the collection channel listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Indicates if the collection is published in the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date."
},
{
"name": "publishedAt",
"description": "The collection publication date.\n\nAdded in Saleor 3.3.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionChannelListingError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": "List of channels IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionChannelListingUpdate",
"description": "Manage collection's availability in channels. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collection",
"description": "An updated collection instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionChannelListingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionChannelListingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionChannelListingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionChannelListingUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to which the collection should be assigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PublishableChannelListingInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeChannels",
"description": "List of channels from which the collection should be unassigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionCountableConnection",
"description": "Represents a connection to a list of collections.",
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionCreate",
"description": "Creates a new collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collection",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "backgroundImage",
"description": "Background image file.",
"type": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "backgroundImageAlt",
"description": "Alt text for an image.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the collection.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Informs whether a collection is published.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the collection metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the collection.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the collection private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products to be added to the collection.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": "Publication date. ISO 8601 standard. \n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the collection.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionCreated",
"description": "Event sent when new collection is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "collection",
"description": "The collection the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionDelete",
"description": "Deletes a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collection",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionDeleted",
"description": "Event sent when collection is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "collection",
"description": "The collection the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Specifies the channel by which the data should be filtered. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "published",
"description": null,
"type": {
"kind": "ENUM",
"name": "CollectionPublished",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "backgroundImage",
"description": "Background image file.",
"type": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "backgroundImageAlt",
"description": "Alt text for an image.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the collection.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Informs whether a collection is published.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the collection metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the collection.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the collection private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": "Publication date. ISO 8601 standard. \n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the collection.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionMetadataUpdated",
"description": "Event sent when collection metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "collection",
"description": "The collection the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionPublished",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "HIDDEN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLISHED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionRemoveProducts",
"description": "Remove products from a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collection",
"description": "Collection from which products will be removed.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionReorderProducts",
"description": "Reorder the products of a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collection",
"description": "Collection from which products are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CollectionSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AVAILABILITY",
"description": "Sort collections by availability.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort collections by name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_COUNT",
"description": "Sort collections by product count.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLICATION_DATE",
"description": "Sort collections by publication date.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLISHED_AT",
"description": "Sort collections by publication date.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Specifies the channel in which to sort the data.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "direction",
"description": "Specifies the direction in which to sort collections.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort collections by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CollectionSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionTranslatableContent",
"description": null,
"fields": [
{
"name": "collection",
"description": "Represents a collection of products.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "description",
"description": "Collection's description to translate.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Description of the collection.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the collection translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Collection's name to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "SEO description to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "SEO title to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated collection fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionTranslate",
"description": "Creates/updates translations for a collection. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "collection",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionTranslation",
"description": null,
"fields": [
{
"name": "description",
"description": "Translated description of the collection.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Translated description of the collection.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the collection translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated collection name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "Translated SEO description.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "Translated SEO title.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionUpdate",
"description": "Updates a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "collection",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CollectionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CollectionUpdated",
"description": "Event sent when collection is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "collection",
"description": "The collection the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CollectionWhereInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "AND",
"description": "List of conditions that must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OR",
"description": "A list of conditions of which at least one must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ConfigurationItem",
"description": "Stores information about a single configuration field.",
"fields": [
{
"name": "helpText",
"description": "Help text for the field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "label",
"description": "Label for the field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the field.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Type of the field.",
"args": [],
"type": {
"kind": "ENUM",
"name": "ConfigurationTypeFieldEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Current value of the field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ConfigurationItemInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "name",
"description": "Name of the field to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of the given field to update.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ConfigurationTypeFieldEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BOOLEAN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MULTILINE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUTPUT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SECRET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SECRETMULTILINE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STRING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ConfirmAccount",
"description": "Confirm user account with token sent by email during registration.\n\nTriggers the following webhook events:\n- ACCOUNT_CONFIRMED (async): Account was confirmed.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "An activated user account.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ConfirmEmailChange",
"description": "Confirm the email change of the logged-in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- NOTIFY_USER (async): A notification that account email change was confirmed.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance with a new email.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CountryCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ME",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ML",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "US",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CountryDisplay",
"description": null,
"fields": [
{
"name": "code",
"description": "Country code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "Country name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "vat",
"description": "Country tax.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "VAT",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Always returns `null`. Use `TaxClassCountryRate` type to manage tax rates per country."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CountryFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attachedToShippingZones",
"description": "Boolean for filtering countries by having shipping zone assigned.If 'true', return countries with shipping zone assigned.If 'false', return countries without any shipping zone assigned.If the argument is not provided (null), return all countries.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CountryRateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "countryCode",
"description": "Country in which this rate applies.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rate",
"description": "Tax rate value provided as percentage. Example: provide `23` to represent `23%` tax rate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CountryRateUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "countryCode",
"description": "Country in which this rate applies.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rate",
"description": "Tax rate value provided as percentage. Example: provide `23` to represent `23%` tax rate. Provide `null` to remove the particular rate.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CreateToken",
"description": "Create JWT token.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "csrfToken",
"description": "CSRF token required to re-generate access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refreshToken",
"description": "JWT refresh token, required to re-generate access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "JWT token, required to authenticate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CreditCard",
"description": null,
"fields": [
{
"name": "brand",
"description": "Card brand.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expMonth",
"description": "Two-digit number representing the card’s expiration month.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expYear",
"description": "Four-digit number representing the card’s expiration year.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstDigits",
"description": "First 4 digits of the card number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastDigits",
"description": "Last 4 digits of the card number.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerBulkDelete",
"description": "Deletes customers. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_DELETED (async): A customer account was deleted.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerBulkResult",
"description": null,
"fields": [
{
"name": "customer",
"description": "Customer data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": "List of errors that occurred during the update attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerBulkUpdateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerBulkUpdate",
"description": "Updates customers.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerBulkUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the updated customers.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerBulkResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerBulkUpdateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CustomerBulkUpdateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerBulkUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BLANK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAX_LENGTH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerBulkUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "externalReference",
"description": "External ID of a customer to update.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a customer to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a customer.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CustomerInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerCreate",
"description": "Creates a new customer. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_CREATED (async): A new customer account was created.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.\n- NOTIFY_USER (async): A notification for setting the password.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerCreated",
"description": "Event sent when new customer user is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerDelete",
"description": "Deletes a customer. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_DELETED (async): A customer account was deleted.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerEvent",
"description": "History log of the customer.",
"fields": [
{
"name": "app",
"description": "App that performed the action.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "count",
"description": "Number of objects concerned by the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "Date when event happened at in ISO 8601 format.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the customer event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Content of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The concerned order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLine",
"description": "The concerned order line.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Customer event type.",
"args": [],
"type": {
"kind": "ENUM",
"name": "CustomerEventsEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User who performed the action.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "CustomerEventsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCOUNT_ACTIVATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_DEACTIVATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DIGITAL_LINK_DOWNLOADED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL_CHANGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL_CHANGED_REQUEST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTE_ADDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTE_ADDED_TO_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_CHANGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_RESET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PASSWORD_RESET_LINK_SENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PLACED_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "dateJoined",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": "Filter by ids. \n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "numberOfOrders",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "IntRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "placedOrders",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "CustomerInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "defaultBillingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultShippingAddress",
"description": "Shipping address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The unique email address of the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the customer.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "Given name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "User account is active.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isConfirmed",
"description": "User account is confirmed.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "User language code.",
"type": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "Family name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the user metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "A note about the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the user private metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerMetadataUpdated",
"description": "Event sent when customer user metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerUpdate",
"description": "Updates an existing customer. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A new customer account was updated.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "CustomerUpdated",
"description": "Event sent when customer user is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Date",
"description": "The `Date` scalar type represents a Date\nvalue as specified by\n[iso8601](https://en.wikipedia.org/wiki/ISO_8601).",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "gte",
"description": "Start date.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lte",
"description": "End date.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "DateTime",
"description": "The `DateTime` scalar type represents a DateTime\nvalue as specified by\n[iso8601](https://en.wikipedia.org/wiki/ISO_8601).",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "gte",
"description": "Start date.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lte",
"description": "End date.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Day",
"description": "The `Day` scalar type represents number of days by integer value.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeactivateAllUserTokens",
"description": "Deactivate all JWT tokens of the currently authenticated user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Decimal",
"description": "Custom Decimal implementation.\n\nReturns Decimal as a float in the API,\nparses float to the Decimal on the way back.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DecimalFilterInput",
"description": "Define the filtering options for decimal fields.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": null,
"inputFields": [
{
"name": "eq",
"description": "The value equal to.",
"type": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneOf",
"description": "The value included in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "range",
"description": "The value in range.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DecimalRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DecimalRangeInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "gte",
"description": "Decimal value greater than or equal to.",
"type": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lte",
"description": "Decimal value less than or equal to.",
"type": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeleteMetadata",
"description": "Delete metadata of an object. To use it, you need to have access to the modified object.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "item",
"description": null,
"args": [],
"type": {
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadataErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DeletePrivateMetadata",
"description": "Delete object's private metadata. To use it, you need to be an authenticated staff user or an app and have access to the modified object.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "item",
"description": null,
"args": [],
"type": {
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadataErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "DeliveryMethod",
"description": "Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as \"click and collect\" and `ShippingMethod` otherwise.\n\nAdded in Saleor 3.1.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "DigitalContent",
"description": "Represents digital content associated with a product variant.",
"fields": [
{
"name": "automaticFulfillment",
"description": "Indicator for automatic fulfillment of digital content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "contentFile",
"description": "File associated with digital content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the digital content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maxDownloads",
"description": "Maximum number of allowed downloads for the digital content.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Product variant assigned to digital content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "urlValidDays",
"description": "Number of days the URL for the digital content remains valid.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "urls",
"description": "List of URLs for the digital variant.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DigitalContentUrl",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "useDefaultSettings",
"description": "Default settings indicator for digital content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DigitalContentCountableConnection",
"description": "A connection to a list of digital content items.",
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DigitalContentCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DigitalContentCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DigitalContentCreate",
"description": "Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "content",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "variant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DigitalContentDelete",
"description": "Remove digital content assigned to given variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "variant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DigitalContentInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "automaticFulfillment",
"description": "Overwrite default automatic_fulfillment setting for variant.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maxDownloads",
"description": "Determines how many times a download link can be accessed by a customer.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the digital content metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the digital content private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "urlValidDays",
"description": "Determines for how many days a download link is active since it was generated.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "useDefaultSettings",
"description": "Use default digital content settings for this product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DigitalContentUpdate",
"description": "Update digital content. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "content",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "variant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DigitalContentUploadInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "automaticFulfillment",
"description": "Overwrite default automatic_fulfillment setting for variant.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "contentFile",
"description": "Represents an file in a multipart request.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maxDownloads",
"description": "Determines how many times a download link can be accessed by a customer.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the digital content metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the digital content private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "urlValidDays",
"description": "Determines for how many days a download link is active since it was generated.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "useDefaultSettings",
"description": "Use default digital content settings for this product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DigitalContentUrl",
"description": "Represents a URL for digital content.",
"fields": [
{
"name": "content",
"description": "Digital content associated with the URL.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": "Date and time when the digital content URL was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "downloadNum",
"description": "Number of times digital content has been downloaded.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the digital content URL.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "UUID of digital content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL for digital content.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DigitalContentUrlCreate",
"description": "Generate new URL to digital content. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "digitalContentUrl",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "DigitalContentUrl",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DigitalContentUrlCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "content",
"description": "Digital content ID which URL will belong to.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DiscountError",
"description": null,
"fields": [
{
"name": "channels",
"description": "List of channels IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DiscountErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DiscountStatusEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SCHEDULED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FIXED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERCENTAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "DistanceUnitsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "M",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Domain",
"description": "Represents shop's domain.",
"fields": [
{
"name": "host",
"description": "The host name of the domain.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sslEnabled",
"description": "Inform if SSL is enabled.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "Shop's absolute URL.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderBulkDelete",
"description": "Deletes draft orders. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderComplete",
"description": "Completes creating an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Completed order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderCreate",
"description": "Creates a new draft order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DraftOrderCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "billingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelId",
"description": "ID of the channel associated with the order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerNote",
"description": "A note from a customer. Visible by customers in the order summary.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discount",
"description": "Discount amount for the order.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this order.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "Variant line input consisting of variant ID and quantity of products.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderLineCreateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "Shipping address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "ID of a selected shipping method.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "Customer associated with the draft order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userEmail",
"description": "Email address of the customer.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "ID of the voucher associated with the order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderCreated",
"description": "Event sent when new draft order is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderDelete",
"description": "Deletes a draft order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderDeleted",
"description": "Event sent when draft order is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "DraftOrderInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "billingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelId",
"description": "ID of the channel associated with the order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerNote",
"description": "A note from a customer. Visible by customers in the order summary.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discount",
"description": "Discount amount for the order.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this order.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "Shipping address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "ID of a selected shipping method.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "Customer associated with the draft order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userEmail",
"description": "Email address of the customer.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "ID of the voucher associated with the order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderLinesBulkDelete",
"description": "Deletes order lines. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderUpdate",
"description": "Updates a draft order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "DraftOrderUpdated",
"description": "Event sent when draft order is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "IGNORE_FAILED",
"description": "Save what is possible within a single row. If there are errors in an input data row, try to save it partially and skip the invalid part.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REJECT_EVERYTHING",
"description": "Reject all rows if there is at least one error in any of them.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REJECT_FAILED_ROWS",
"description": "Reject rows with errors.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Event",
"description": null,
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AccountChangeEmailRequested",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AccountConfirmationRequested",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AccountConfirmed",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AccountDeleteRequested",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AddressCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AddressDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AddressUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppInstalled",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppStatusChanged",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValueCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValueDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValueUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CalculateTaxes",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CategoryCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CategoryDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CategoryUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ChannelCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ChannelDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ChannelMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ChannelStatusChanged",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ChannelUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CheckoutCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CheckoutFilterShippingMethods",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CheckoutFullyPaid",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CheckoutMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CheckoutUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CustomerCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CustomerMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CustomerUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrderCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrderDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DraftOrderUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "FulfillmentApproved",
"ofType": null
},
{
"kind": "OBJECT",
"name": "FulfillmentCanceled",
"ofType": null
},
{
"kind": "OBJECT",
"name": "FulfillmentCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "FulfillmentMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardSent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardStatusChanged",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "InvoiceDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "InvoiceRequested",
"ofType": null
},
{
"kind": "OBJECT",
"name": "InvoiceSent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItemCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItemDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItemUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderBulkCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderCancelled",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderConfirmed",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderExpired",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderFilterShippingMethods",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderFulfilled",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderFullyPaid",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderFullyRefunded",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderPaid",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderRefunded",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageTypeCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageTypeDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageTypeUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentAuthorize",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentCaptureEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentConfirmEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentGatewayInitializeSession",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentListGateways",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentProcessEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentRefundEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PaymentVoidEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductMediaCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductMediaDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductMediaUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBackInStock",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantOutOfStock",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantStockUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleToggle",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingListMethodsForCheckout",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "StaffCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "StaffDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "StaffUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ThumbnailCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionCancelationRequested",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionChargeRequested",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionInitializeSession",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionItemMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionProcessSession",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionRefundRequested",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TranslationCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TranslationUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "WarehouseCreated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "WarehouseDeleted",
"ofType": null
},
{
"kind": "OBJECT",
"name": "WarehouseMetadataUpdated",
"ofType": null
},
{
"kind": "OBJECT",
"name": "WarehouseUpdated",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "EventDelivery",
"description": "Event delivery.",
"fields": [
{
"name": "attempts",
"description": "Event delivery attempts.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Event delivery sorter",
"type": {
"kind": "INPUT_OBJECT",
"name": "EventDeliveryAttemptSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "EventDeliveryAttemptCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "Creation time of an event delivery.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "eventType",
"description": "Webhook event type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of an event delivery.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payload",
"description": "Event payload.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Event delivery status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "EventDeliveryStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "EventDeliveryAttempt",
"description": "Event delivery attempts.",
"fields": [
{
"name": "createdAt",
"description": "Event delivery creation date and time.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "duration",
"description": "Delivery attempt duration.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of Event Delivery Attempt.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requestHeaders",
"description": "Request headers for delivery attempt.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "response",
"description": "Delivery attempt response content.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "responseHeaders",
"description": "Response headers for delivery attempt.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "responseStatusCode",
"description": "Delivery attempt response status code.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Event delivery status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "EventDeliveryStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taskId",
"description": "Task id for delivery attempt.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "EventDeliveryAttemptCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventDeliveryAttemptCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "EventDeliveryAttemptCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventDeliveryAttempt",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "EventDeliveryAttemptSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort event delivery attempts by created at.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "EventDeliveryAttemptSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort attempts.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort attempts by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "EventDeliveryAttemptSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "EventDeliveryCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventDeliveryCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "EventDeliveryCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "EventDelivery",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "EventDeliveryFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "eventType",
"description": null,
"type": {
"kind": "ENUM",
"name": "WebhookEventTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"type": {
"kind": "ENUM",
"name": "EventDeliveryStatusEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "EventDeliveryRetry",
"description": "Retries event delivery. \n\nRequires one of the following permissions: MANAGE_APPS.",
"fields": [
{
"name": "delivery",
"description": "Event delivery.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "EventDelivery",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "EventDeliverySortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort event deliveries by created at.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "EventDeliverySortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort deliveries.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort deliveries by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "EventDeliverySortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "EventDeliveryStatusEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FAILED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PENDING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExportError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ExportErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ExportErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExportEvent",
"description": "History log of export file.",
"fields": [
{
"name": "app",
"description": "App which performed the action. Requires one of the following permissions: OWNER, MANAGE_APPS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "Date when event happened at in ISO 8601 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Content of the event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Export event type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ExportEventsEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User who performed the action. Requires one of the following permissions: OWNER, MANAGE_STAFF.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ExportEventsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "EXPORTED_FILE_SENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPORT_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPORT_FAILED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPORT_FAILED_INFO_SENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPORT_PENDING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPORT_SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExportFile",
"description": "Represents a job data of exported file.",
"fields": [
{
"name": "app",
"description": "The app which requests file export.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "Created date time of job in ISO 8601 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "List of events associated with the export.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExportEvent",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the export file.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Job message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Job status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "JobStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Date time of job last update in ISO 8601 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL of field to download.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user who requests file export.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Job",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExportFileCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExportFileCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExportFileCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExportFile",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ExportFileFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "app",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"type": {
"kind": "ENUM",
"name": "JobStatusEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ExportFileSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_MODIFIED_AT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STATUS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATED_AT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ExportFileSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort export file.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort export file by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ExportFileSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExportGiftCards",
"description": "Export gift cards to csv file.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for the exported file.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExportError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "exportFile",
"description": "The newly created export file job which is responsible for export data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ExportFile",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ExportGiftCardsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "fileType",
"description": "Type of exported file.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "FileTypesEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for gift cards.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GiftCardFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": "List of gift cards IDs to export.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "scope",
"description": "Determine which gift cards should be exported.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ExportScope",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ExportInfoInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attribute ids witch should be exported.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": "List of channels ids which should be exported.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fields",
"description": "List of product fields witch should be exported.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductFieldEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouse ids witch should be exported.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExportProducts",
"description": "Export products to csv file. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for the exported file.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExportError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "exportErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExportError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "exportFile",
"description": "The newly created export file job which is responsible for export data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ExportFile",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ExportProductsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "exportInfo",
"description": "Input with info about fields which should be exported.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ExportInfoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fileType",
"description": "Type of exported file.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "FileTypesEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for products.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": "List of products IDs to export.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "scope",
"description": "Determine which products should be exported.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ExportScope",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ExportScope",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALL",
"description": "Export all products.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FILTER",
"description": "Export the filtered products.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IDS",
"description": "Export products with given ids.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalAuthentication",
"description": "External authentication plugin.",
"fields": [
{
"name": "id",
"description": "ID of external authentication plugin.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of external authentication plugin.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalAuthenticationUrl",
"description": "Prepare external authentication URL for user by custom plugin.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "authenticationData",
"description": "The data returned by authentication plugin.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalLogout",
"description": "Logout user by custom plugin.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "logoutData",
"description": "The data returned by authentication plugin.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalNotificationError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ExternalNotificationErrorCodes",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ExternalNotificationErrorCodes",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CHANNEL_INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_MODEL_TYPE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalNotificationTrigger",
"description": "Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload.\n\nAdded in Saleor 3.1.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExternalNotificationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ExternalNotificationTriggerInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "externalEventType",
"description": "External event type. This field is passed to a plugin as an event type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "extraPayload",
"description": "Additional payload that will be merged with the one based on the bussines object ID.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": "The list of customers or orders node IDs that will be serialized and included in the notification payload.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalObtainAccessTokens",
"description": "Obtain external access tokens for user by custom plugin.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "csrfToken",
"description": "CSRF token required to re-generate external access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refreshToken",
"description": "The refresh token, required to re-generate external access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The token, required to authenticate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalRefresh",
"description": "Refresh user's access by custom plugin.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "csrfToken",
"description": "CSRF token required to re-generate external access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refreshToken",
"description": "The refresh token, required to re-generate external access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The token, required to authenticate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ExternalVerify",
"description": "Verify external authentication data by plugin.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isValid",
"description": "Determine if authentication data is valid or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User assigned to data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "verifyData",
"description": "External data.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "File",
"description": null,
"fields": [
{
"name": "contentType",
"description": "Content type of the file.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL of the file.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "FileTypesEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CSV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XLSX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FileUpload",
"description": "Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UploadError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "uploadErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UploadError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "uploadedFile",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "File",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Float",
"description": "The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Fulfillment",
"description": "Represents order fulfillment.",
"fields": [
{
"name": "created",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentOrder",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of lines for the fulfillment.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "FulfillmentLine",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "FulfillmentStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "statusDisplay",
"description": "User-friendly fulfillment status.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackingNumber",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "Warehouse from fulfillment was fulfilled.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentApprove",
"description": "Approve existing fulfillment.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillment",
"description": "An approved fulfillment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which fulfillment was approved.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentApproved",
"description": "Event sent when fulfillment is approved.\n\nAdded in Saleor 3.7.",
"fields": [
{
"name": "fulfillment",
"description": "The fulfillment the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the fulfillment belongs to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentCancel",
"description": "Cancels existing fulfillment and optionally restocks items. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillment",
"description": "A canceled fulfillment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which fulfillment was cancelled.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "FulfillmentCancelInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "warehouseId",
"description": "ID of a warehouse where items will be restocked. Optional when fulfillment is in WAITING_FOR_APPROVAL state.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentCanceled",
"description": "Event sent when fulfillment is canceled.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "fulfillment",
"description": "The fulfillment the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the fulfillment belongs to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentCreated",
"description": "Event sent when new fulfillment is created.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "fulfillment",
"description": "The fulfillment the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the fulfillment belongs to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentLine",
"description": "Represents line of the fulfillment.",
"fields": [
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLine",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentMetadataUpdated",
"description": "Event sent when fulfillment metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "fulfillment",
"description": "The fulfillment the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the fulfillment belongs to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentRefundProducts",
"description": "Refund products. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillment",
"description": "A refunded fulfillment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which fulfillment was refunded.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentReturnProducts",
"description": "Return products. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which fulfillment was returned.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "replaceFulfillment",
"description": "A replace fulfillment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "replaceOrder",
"description": "A draft order which was created for products with replace flag.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "returnFulfillment",
"description": "A return fulfillment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "FulfillmentStatus",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANCELED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUNDED_AND_RETURNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REPLACED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RETURNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAITING_FOR_APPROVAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "FulfillmentUpdateTracking",
"description": "Updates a fulfillment for an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillment",
"description": "A fulfillment with updated tracking.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order for which fulfillment was updated.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "FulfillmentUpdateTrackingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "notifyCustomer",
"description": "If true, send an email notification to the customer.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackingNumber",
"description": "Fulfillment tracking number.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GatewayConfigLine",
"description": "Payment gateway client configuration key and value pair.",
"fields": [
{
"name": "field",
"description": "Gateway config key.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Gateway config value for key.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "GenericScalar",
"description": "The `GenericScalar` scalar type represents a generic\nGraphQL scalar value that could be:\nString, Boolean, Int, Float, List or Object.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCard",
"description": "A gift card is a prepaid electronic payment card accepted in stores. They can be used during checkout by providing a valid gift card codes.",
"fields": [
{
"name": "app",
"description": "App which created the gift card.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_APPS, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "boughtInChannel",
"description": "Slug of the channel where the gift card was bought.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "Gift card code. Can be fetched by a staff member with MANAGE_GIFT_CARD when gift card wasn't yet used and by the gift card owner.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdBy",
"description": "The user who bought or issued a gift card.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdByEmail",
"description": "Email address of the user who bought or issued gift card.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_USERS, OWNER.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currentBalance",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayCode",
"description": "Code in format which allows displaying in a user interface.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endDate",
"description": "End date of gift card.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `expiryDate` field instead."
},
{
"name": "events",
"description": "List of events associated with the gift card.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [
{
"name": "filter",
"description": "Filtering options for gift card events.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GiftCardEventFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardEvent",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryDate",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "initialBalance",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last4CodeChars",
"description": "Last 4 characters of gift card code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastUsedOn",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "Related gift card product.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startDate",
"description": "Start date of gift card.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "tags",
"description": "The gift card tag.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardTag",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usedBy",
"description": "The customer who used a gift card.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "usedByEmail",
"description": "Email address of the customer who used a gift card.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "user",
"description": "The customer who bought a gift card.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `createdBy` field instead."
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardActivate",
"description": "Activate a gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was activated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "Activated gift card.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardAddNote",
"description": "Adds note to the gift card.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_UPDATED (async): A gift card was updated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "event",
"description": "Gift card note created.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCardEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "Gift card with the note added.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardAddNoteInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "message",
"description": "Note message.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardBulkActivate",
"description": "Activate gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was activated.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardBulkCreate",
"description": "Create gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_CREATED (async): A gift card was created.\n- NOTIFY_USER (async): A notification for created gift card.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCards",
"description": "List of created gift cards.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardBulkCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "balance",
"description": "Balance of the gift card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PriceInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "count",
"description": "The number of cards to issue.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryDate",
"description": "The gift card expiry date.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if gift card is active.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tags",
"description": "The gift card tags.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardBulkDeactivate",
"description": "Deactivate gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardBulkDelete",
"description": "Delete gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_DELETED (async): A gift card was deleted.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardCreate",
"description": "Creates a new gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_CREATED (async): A gift card was created.\n- NOTIFY_USER (async): A notification for created gift card.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addTags",
"description": "The gift card tags to add.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "balance",
"description": "Balance of the gift card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PriceInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel from which the email should be sent.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "Code to use the gift card. \n\nDEPRECATED: this field will be removed in Saleor 4.0. The code is now auto generated.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endDate",
"description": "End date of the gift card in ISO 8601 format. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryDate",
"description": "The gift card expiry date.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if gift card is active.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "The gift card note from the staff member.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startDate",
"description": "Start date of the gift card in ISO 8601 format. \n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userEmail",
"description": "Email of the customer to whom gift card will be sent.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardCreated",
"description": "Event sent when new gift card is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "giftCard",
"description": "The gift card the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardDeactivate",
"description": "Deactivate a gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "Deactivated gift card.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardDelete",
"description": "Delete gift card.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_DELETED (async): A gift card was deleted.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardDeleted",
"description": "Event sent when gift card is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "giftCard",
"description": "The gift card the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "GiftCardErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tags",
"description": "List of tag values that cause the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "GiftCardErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED_GIFT_CARD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardEvent",
"description": "History log of the gift card.\n\nAdded in Saleor 3.1.",
"fields": [
{
"name": "app",
"description": "App that performed the action. Requires one of the following permissions: MANAGE_APPS, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "balance",
"description": "The gift card balance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCardEventBalance",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "Date when event happened at in ISO 8601 format.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email of the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryDate",
"description": "The gift card expiry date.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Content of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldExpiryDate",
"description": "Previous gift card expiry date.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldTags",
"description": "The list of old gift card tags.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderId",
"description": "The order ID where gift card was used or bought.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderNumber",
"description": "User-friendly number of an order where gift card was used or bought.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tags",
"description": "The list of gift card tags.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Gift card event type.",
"args": [],
"type": {
"kind": "ENUM",
"name": "GiftCardEventsEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User who performed the action. Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardEventBalance",
"description": null,
"fields": [
{
"name": "currentBalance",
"description": "Current balance of the gift card.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "initialBalance",
"description": "Initial balance of the gift card.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldCurrentBalance",
"description": "Previous current balance of the gift card.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldInitialBalance",
"description": "Previous initial balance of the gift card.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardEventFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "orders",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": null,
"type": {
"kind": "ENUM",
"name": "GiftCardEventsEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "GiftCardEventsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACTIVATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BALANCE_RESET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BOUGHT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DEACTIVATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRY_DATE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ISSUED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTE_ADDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RESENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SENT_TO_CUSTOMER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAGS_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "USED_IN_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "code",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdByEmail",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currentBalance",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "PriceRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "initialBalance",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "PriceRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tags",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "used",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usedBy",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardMetadataUpdated",
"description": "Event sent when gift card metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "giftCard",
"description": "The gift card the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardResend",
"description": "Resend a gift card.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for gift card resend.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "Gift card which has been sent.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardResendInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Slug of a channel from which the email should be sent.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email to which gift card should be send.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a gift card to resend.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardSent",
"description": "Event sent when gift card is e-mailed.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "channel",
"description": "Slug of a channel for which this gift card email was sent.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "The gift card the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sentToEmail",
"description": "E-mail address to which gift card was sent.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardSettings",
"description": "Gift card related settings from site settings.",
"fields": [
{
"name": "expiryPeriod",
"description": "The gift card expiry period settings.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TimePeriod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryType",
"description": "The gift card expiry type settings.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "GiftCardSettingsExpiryTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardSettingsError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "GiftCardSettingsErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "GiftCardSettingsErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "GiftCardSettingsExpiryTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "EXPIRY_PERIOD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NEVER_EXPIRE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardSettingsUpdate",
"description": "Update gift card settings. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardSettingsError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardSettings",
"description": "Gift card settings.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCardSettings",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardSettingsUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "expiryPeriod",
"description": "Defines gift card expiry period.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TimePeriodInputType",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryType",
"description": "Defines gift card default expiry settings.",
"type": {
"kind": "ENUM",
"name": "GiftCardSettingsExpiryTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "GiftCardSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort gift cards by created at.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CURRENT_BALANCE",
"description": "Sort gift cards by current balance.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT",
"description": "Sort gift cards by product.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "USED_BY",
"description": "Sort gift cards by used by.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort gift cards.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort gift cards by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "GiftCardSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardStatusChanged",
"description": "Event sent when gift card status has changed.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "giftCard",
"description": "The gift card the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardTag",
"description": "The gift card tag.\n\nAdded in Saleor 3.1.",
"fields": [
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardTagCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardTagCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardTagCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardTag",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardTagFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardUpdate",
"description": "Update a gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_UPDATED (async): A gift card was updated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GiftCardUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addTags",
"description": "The gift card tags to add.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "balanceAmount",
"description": "The gift card balance amount.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endDate",
"description": "End date of the gift card in ISO 8601 format. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expiryDate",
"description": "The gift card expiry date.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeTags",
"description": "The gift card tags to remove.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startDate",
"description": "Start date of the gift card in ISO 8601 format. \n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GiftCardUpdated",
"description": "Event sent when gift card is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "giftCard",
"description": "The gift card the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "GlobalIDFilterInput",
"description": "Define the filtering options for foreign key fields.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": null,
"inputFields": [
{
"name": "eq",
"description": "The value equal to.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneOf",
"description": "The value included in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Group",
"description": "Represents permission group data.",
"fields": [
{
"name": "accessibleChannels",
"description": "List of channels the group has access to.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the group.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the group.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of group permissions",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Permission",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restrictedAccessToChannels",
"description": "Determine if the group have restricted access to channels.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userCanManage",
"description": "True, if the currently authenticated user has rights to manage a group.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "users",
"description": "List of group users\n\nRequires one of the following permissions: MANAGE_STAFF.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "User",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GroupCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GroupCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "GroupCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "ID",
"description": "The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "IconThumbnailFormatEnum",
"description": "Thumbnail formats for icon images.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ORIGINAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WEBP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Image",
"description": "Represents an image.",
"fields": [
{
"name": "alt",
"description": "Alt text for an image.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL of the image.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Int",
"description": "The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "IntRangeInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "gte",
"description": "Value greater than or equal to.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lte",
"description": "Value less than or equal to.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Invoice",
"description": "Represents an Invoice.",
"fields": [
{
"name": "createdAt",
"description": "Date and time at which invoice was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalUrl",
"description": "URL to view an invoice.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Message associated with an invoice.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "number",
"description": "Invoice number.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order related to the invoice.\n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Job status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "JobStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Date and time at which invoice was updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL to download an invoice.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Job",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceCreate",
"description": "Creates a ready to send invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoice",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "InvoiceCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "metadata",
"description": "Fields required to update the invoice metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "number",
"description": "Invoice number.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the invoice private metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL of an invoice to download.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceDelete",
"description": "Deletes an invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoice",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceDeleted",
"description": "Event sent when invoice is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "invoice",
"description": "The invoice the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order related to the invoice.\n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "InvoiceErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "InvoiceErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "EMAIL_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_STATUS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_READY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_INVOICE_PLUGIN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NUMBER_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "URL_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceRequest",
"description": "Request an invoice for the order using plugin. \n\nRequires one of the following permissions: MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- INVOICE_REQUESTED (async): An invoice was requested.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoice",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "order",
"description": "Order related to an invoice.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceRequestDelete",
"description": "Requests deletion of an invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- INVOICE_DELETED (async): An invoice was requested to delete.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoice",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceRequested",
"description": "Event sent when invoice is requested.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "invoice",
"description": "The invoice the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order related to the invoice.\n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceSendNotification",
"description": "Send an invoice notification to the customer. \n\nRequires one of the following permissions: MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- INVOICE_SENT (async): A notification for invoice send\n- NOTIFY_USER (async): A notification for invoice send",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoice",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceSent",
"description": "Event sent when invoice is sent.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "invoice",
"description": "The invoice the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order related to the invoice.\n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "InvoiceUpdate",
"description": "Updates an invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoice",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "InvoiceError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "IssuingPrincipal",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "App",
"ofType": null
},
{
"kind": "OBJECT",
"name": "User",
"ofType": null
}
]
},
{
"kind": "SCALAR",
"name": "JSON",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "JSONString",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Job",
"description": null,
"fields": [
{
"name": "createdAt",
"description": "Created date time of job in ISO 8601 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Job message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Job status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "JobStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Date time of job last update in ISO 8601 format.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ExportFile",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
}
]
},
{
"kind": "ENUM",
"name": "JobStatusEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FAILED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PENDING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "LanguageCodeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AF_NA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AF_ZA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AGQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AGQ_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AK_GH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AM_ET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_AE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_BH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_DJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_DZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_EG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_EH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_ER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_IL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_IQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_JO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_KW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_LB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_LY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_MA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_MR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_OM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_PS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_QA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_SA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_SD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_SO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_SS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_SY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_TD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_TN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AR_YE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ASA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ASA_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AST_ES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AS_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZ_CYRL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZ_CYRL_AZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZ_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AZ_LATN_AZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BAS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BAS_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BEM_ZM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BEZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BEZ_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BE_BY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BG_BG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BM_ML",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BN_BD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BN_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BO_CN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BO_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BRX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BRX_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BR_FR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BS_CYRL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BS_CYRL_BA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BS_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BS_LATN_BA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_AD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_ES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_ES_VALENCIA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_FR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CA_IT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CCP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CCP_BD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CCP_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CEB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CEB_PH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CE_RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CGG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CGG_UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHR_US",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CKB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CKB_IQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CKB_IR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CS_CZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CU_RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CY_GB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DAV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DAV_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DA_DK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DA_GL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE_AT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE_BE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE_DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE_IT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE_LI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DE_LU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DJE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DJE_NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DSB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DSB_DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUA_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DYO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DYO_SN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DZ_BT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EBU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EBU_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EE_GH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EE_TG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EL_CY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EL_GR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_AE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_AG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_AI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_AS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_AT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_AU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_BB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_BE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_BI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_BM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_BS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_BW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_BZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_CA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_CC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_CK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_CX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_CY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_DG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_DK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_DM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_ER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_FI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_FJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_FK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_FM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_GY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_HK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_IE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_IL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_IM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_IO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_JE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_JM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_KI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_KN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_KY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_LC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_LR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_LS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_MY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_NA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_NF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_NL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_NR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_NU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_NZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_PG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_PH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_PK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_PN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_PR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_PW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_RW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_SZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_TC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_TK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_TO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_TT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_TV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_UM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_US",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_VC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_VG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_VI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_VU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_WS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_ZA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_ZM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EN_ZW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_AR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_BO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_BR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_BZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_CL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_CO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_CR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_CU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_DO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_EA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_EC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_ES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_GQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_GT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_HN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_IC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_MX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_NI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_PA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_PE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_PH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_PR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_PY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_SV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_US",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_UY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ES_VE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ET_EE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EU_ES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EWO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EWO_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FA_AF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FA_IR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_BF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_GH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_GM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_GN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_GW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_LR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_MR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_SL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_ADLM_SN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_BF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_GH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_GM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_GN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_GW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_LR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_MR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_SL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FF_LATN_SN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FIL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FIL_PH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FI_FI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FO_DK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FO_FO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_BE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_BF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_BI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_BJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_BL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_CA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_CD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_CF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_CG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_CI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_DJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_DZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_FR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_GA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_GF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_GN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_GP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_GQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_HT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_LU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_MA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_MC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_MF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_MG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_ML",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_MQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_MR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_MU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_NC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_PF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_PM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_RE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_RW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_SC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_SN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_SY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_TD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_TG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_TN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_VU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_WF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FR_YT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FUR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FUR_IT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FY_NL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GA_GB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GA_IE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GD_GB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GL_ES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GSW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GSW_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GSW_FR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GSW_LI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GUZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GUZ_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GU_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GV_IM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HAW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HAW_US",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HA_GH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HA_NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HA_NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HE_IL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HI_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HR_BA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HR_HR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HSB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HSB_DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HU_HU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HY_AM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ID_ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IG_NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "II",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "II_CN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IS_IS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IT_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IT_IT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IT_SM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IT_VA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JA_JP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JGO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JGO_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JMC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JMC_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "JV_ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KAB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KAB_DZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KAM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KAM_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KA_GE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KDE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KDE_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KEA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KEA_CV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KHQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KHQ_ML",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KI_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KKJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KKJ_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KK_KZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KLN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KLN_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KL_GL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KM_KH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KN_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KOK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KOK_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KO_KP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KO_KR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KSB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KSB_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KSF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KSF_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KSH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KSH_DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KS_ARAB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KS_ARAB_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KU_TR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KW_GB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KY_KG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAG_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LB_LU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LG_UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LKT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LKT_US",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LN_AO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LN_CD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LN_CF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LN_CG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LO_LA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LRC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LRC_IQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LRC_IR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LT_LT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LUO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LUO_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LUY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LUY_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LU_CD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LV_LV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAI_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAS_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAS_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MER_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MFE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MFE_MU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MGH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MGH_MZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MGO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MGO_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MG_MG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MI_NZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MK_MK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ML",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ML_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MNI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MNI_BENG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MNI_BENG_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MN_MN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MR_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MS_BN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MS_ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MS_MY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MS_SG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MT_MT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MUA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MUA_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MY_MM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MZN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MZN_IR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAQ_NA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NB_NO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NB_SJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NDS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NDS_DE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NDS_NL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ND_ZW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NE_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NE_NP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL_AW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL_BE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL_BQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL_CW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL_NL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL_SR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NL_SX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NMG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NMG_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NNH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NNH_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NN_NO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NUS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NUS_SS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NYN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NYN_UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OM_ET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OM_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OR_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OS_GE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OS_RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PA_ARAB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PA_ARAB_PK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PA_GURU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PA_GURU_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PCM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PCM_NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PL_PL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PS_AF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PS_PK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_AO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_BR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_CV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_GQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_GW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_LU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_MO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_MZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_PT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_ST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PT_TL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QU_BO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QU_EC",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QU_PE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RM_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RN_BI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ROF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ROF_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RO_MD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RO_RO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU_BY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU_KG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU_KZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU_MD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU_RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RU_UA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RWK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RWK_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RW_RW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAH_RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAQ_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAT_OLCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SAT_OLCK_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SBP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SBP_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD_ARAB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD_ARAB_PK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD_DEVA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SD_DEVA_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SEH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SEH_MZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SES_ML",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SE_FI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SE_NO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SE_SE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SG_CF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHI_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHI_LATN_MA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHI_TFNG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHI_TFNG_MA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SI_LK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SK_SK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SL_SI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SMN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SMN_FI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SN_ZW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SO_DJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SO_ET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SO_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SO_SO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_AL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_MK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_XK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_CYRL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_CYRL_BA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_CYRL_ME",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_CYRL_RS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_CYRL_XK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_LATN_BA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_LATN_ME",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_LATN_RS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SR_LATN_XK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SU_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SU_LATN_ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SV_AX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SV_FI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SV_SE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SW_CD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SW_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SW_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SW_UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TA_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TA_LK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TA_MY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TA_SG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TEO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TEO_KE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TEO_UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TE_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TG_TJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TH_TH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TI_ER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TI_ET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TK_TM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TO_TO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TR_CY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TR_TR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TT_RU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TWQ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TWQ_NE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TZM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TZM_MA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UG_CN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UK_UA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UR_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UR_PK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ_ARAB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ_ARAB_AF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ_CYRL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ_CYRL_UZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UZ_LATN_UZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VAI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VAI_LATN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VAI_LATN_LR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VAI_VAII",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VAI_VAII_LR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VI_VN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VUN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VUN_TZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAE_CH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WO_SN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XH_ZA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XOG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "XOG_UG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YAV",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YAV_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YI",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YO_BJ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YO_NG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YUE_HANS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YUE_HANS_CN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YUE_HANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YUE_HANT_HK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZGH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZGH_MA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANS_CN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANS_HK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANS_MO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANS_SG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANT_HK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANT_MO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZH_HANT_TW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZU_ZA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "LanguageDisplay",
"description": null,
"fields": [
{
"name": "code",
"description": "ISO 639 representation of the language name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Full name of the language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "LimitInfo",
"description": "Store the current and allowed usage.",
"fields": [
{
"name": "allowedUsage",
"description": "Defines the allowed maximum resource usage, null means unlimited.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Limits",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currentUsage",
"description": "Defines the current resource usage.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Limits",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Limits",
"description": null,
"fields": [
{
"name": "channels",
"description": "Defines the number of channels.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orders",
"description": "Defines the number of order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariants",
"description": "Defines the number of product variants.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffUsers",
"description": "Defines the number of staff users.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "Defines the number of warehouses.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Manifest",
"description": "The manifest definition.",
"fields": [
{
"name": "about",
"description": "Description of the app displayed in the dashboard.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appUrl",
"description": "App website rendered in the dashboard.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "audience",
"description": "The audience that will be included in all JWT tokens for the app.\n\nAdded in Saleor 3.8.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "author",
"description": "The App's author name.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "brand",
"description": "App's brand data.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppManifestBrand",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "configurationUrl",
"description": "URL to iframe with the configuration for the app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `appUrl` instead."
},
{
"name": "dataPrivacy",
"description": "Description of the data privacy defined for this app.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead."
},
{
"name": "dataPrivacyUrl",
"description": "URL to the full privacy policy.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "extensions",
"description": "List of extensions that will be mounted in Saleor's dashboard. For details, please [see the extension section.](https://docs.saleor.io/docs/3.x/developer/extending/apps/extending-dashboard-with-apps#key-concepts)",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppManifestExtension",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "homepageUrl",
"description": "External URL to the app homepage.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "identifier",
"description": "The identifier of the manifest for the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the manifest for the app .",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "The array permissions required for the app.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Permission",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requiredSaleorVersion",
"description": "Determines the app's required Saleor version as semver range.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "AppManifestRequiredSaleorVersion",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "supportUrl",
"description": "External URL to the page where app users can find support.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tokenTargetUrl",
"description": "Endpoint used during process of app installation, [see installing an app.](https://docs.saleor.io/docs/3.x/developer/extending/apps/installing-apps#installing-an-app)",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "The version of the manifest for the app.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhooks",
"description": "List of the app's webhooks.\n\nAdded in Saleor 3.5.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppManifestWebhook",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Margin",
"description": "Metadata for the Margin class.",
"fields": [
{
"name": "start",
"description": "The starting value of the margin.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stop",
"description": "The ending value of the margin.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MarkAsPaidStrategyEnum",
"description": "Determine the mark as paid strategy for the channel.\n\n TRANSACTION_FLOW - new orders marked as paid will receive a\n `TransactionItem` object, that will cover the `order.total`.\n\n PAYMENT_FLOW - new orders marked as paid will receive a\n `Payment` object, that will cover the `order.total`.\n\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PAYMENT_FLOW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_FLOW",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MeasurementUnitsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACRE_FT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACRE_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_CENTIMETER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_DECIMETER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_FOOT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_INCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_METER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_MILLIMETER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_YARD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FL_OZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "G",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LITER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "M",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PINT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_CM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_DM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_FT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_INCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_KM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_M",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_MM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SQ_YD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TONNE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MeasurementUnitsEnumFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "eq",
"description": "The value equal to.",
"type": {
"kind": "ENUM",
"name": "MeasurementUnitsEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneOf",
"description": "The value included in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MeasurementUnitsEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MediaChoicesSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ID",
"description": "Sort media by ID.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MediaInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "alt",
"description": "Alt text for a product media.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "image",
"description": "Represents an image file in a multipart request.",
"type": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "mediaUrl",
"description": "Represents an URL to an external media.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MediaSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort media.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort media by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MediaChoicesSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Menu",
"description": "Represents a single menu - an object that is used to help navigate through the store.",
"fields": [
{
"name": "id",
"description": "The ID of the menu.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "items",
"description": "Menu items associated with this menu.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the menu.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the menu.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuBulkDelete",
"description": "Deletes menus. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_DELETED (async): A menu was deleted.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuCreate",
"description": "Creates a new Menu. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_CREATED (async): A menu was created.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "items",
"description": "List of menu items.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MenuItemInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the menu.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the menu. Will be generated if not provided.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuCreated",
"description": "Event sent when new menu is created.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "The menu the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuDelete",
"description": "Deletes a menu. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_DELETED (async): A menu was deleted.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuDeleted",
"description": "Event sent when menu is deleted.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "The menu the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MenuErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MenuErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANNOT_ASSIGN_NODE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_MENU_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_MENU_ITEM_PROVIDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOO_MANY_MENU_ITEMS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "name",
"description": "Name of the menu.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the menu.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItem",
"description": "Represents a single item of the related menu. Can store categories, collection or pages.",
"fields": [
{
"name": "category",
"description": "Category associated with the menu item.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "children",
"description": "Represents the child items of the current menu item.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collection",
"description": "A collection associated with this menu item. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the menu item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "level",
"description": "Indicates the position of the menu item within the menu structure.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "Represents the menu to which the menu item belongs.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the menu item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "A page associated with this menu item. Requires one of the following permissions to include unpublished items: MANAGE_PAGES.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "parent",
"description": "ID of parent menu item. If empty, menu will be top level menu.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated menu item fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for menu item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL to the menu item.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemBulkDelete",
"description": "Deletes menu items. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_DELETED (async): A menu item was deleted.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuItemCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemCreate",
"description": "Creates a new menu item. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_CREATED (async): A menu item was created.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "menuItem",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuItemCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "category",
"description": "Category to which item points.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collection",
"description": "Collection to which item points.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "Menu to which item belongs.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the menu item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "Page to which item points.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "parent",
"description": "ID of the parent menu. If empty, menu will be top level menu.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL of the pointed item.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemCreated",
"description": "Event sent when new menu item is created.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItem",
"description": "The menu item the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemDelete",
"description": "Deletes a menu item. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_DELETED (async): A menu item was deleted.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "menuItem",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemDeleted",
"description": "Event sent when menu item is deleted.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItem",
"description": "The menu item the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuItemFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuItemInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "category",
"description": "Category to which item points.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collection",
"description": "Collection to which item points.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the menu item.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "Page to which item points.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL of the pointed item.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemMove",
"description": "Moves items of menus. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_UPDATED (async): Optionally triggered when sort order or parent changed for menu item.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "Assigned menu to move within.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuItemMoveInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "itemId",
"description": "The menu item ID to move.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "parentId",
"description": "ID of the parent menu. If empty, menu will be top level menu.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortOrder",
"description": "The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuItemSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort menu items.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort menu items by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MenuItemsSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemTranslatableContent",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the menu item translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItem",
"description": "Represents a single item of the related menu. Can store categories, collection or pages.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "name",
"description": "Name of the menu item to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated menu item fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for menu item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemTranslate",
"description": "Creates/updates translations for a menu item. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItem",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemTranslation",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the menu item translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated menu item name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemUpdate",
"description": "Updates a menu item. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_UPDATED (async): A menu item was updated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "menuItem",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuItemUpdated",
"description": "Event sent when menu item is updated.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItem",
"description": "The menu item the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MenuItemsSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort menu items by name.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MenuSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ITEMS_COUNT",
"description": "Sort menus by items count.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort menus by name.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MenuSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort menus.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort menus by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MenuSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuUpdate",
"description": "Updates a menu. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_UPDATED (async): A menu was updated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MenuError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MenuUpdated",
"description": "Event sent when menu is updated.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "The menu the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Metadata",
"description": "Metadata is a map of key-value pairs, both keys and values are `String`.\n\nExample:\n```\n{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}\n```",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MetadataError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MetadataErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "MetadataErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"description": null,
"fields": null,
"inputFields": [
{
"name": "key",
"description": "Key of a metadata item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of a metadata item.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "key",
"description": "Key of a metadata item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of a metadata item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MetadataItem",
"description": null,
"fields": [
{
"name": "key",
"description": "Key of a metadata item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of a metadata item.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Minute",
"description": "The `Minute` scalar type represents number of minutes by integer value.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Money",
"description": "Represents amount of money in specific currency.",
"fields": [
{
"name": "amount",
"description": "Amount of money.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amount",
"description": "Amount of money.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "MoneyRange",
"description": "Represents a range of amounts of money.",
"fields": [
{
"name": "start",
"description": "Lower bound of a price range.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stop",
"description": "Upper bound of a price range.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "MoveProductInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "productId",
"description": "The ID of the product to move.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortOrder",
"description": "The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Mutation",
"description": null,
"fields": [
{
"name": "accountAddressCreate",
"description": "Create a new address for the customer. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- ADDRESS_CREATED (async): An address was created.",
"args": [
{
"name": "input",
"description": "Fields required to create address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "A type of address. If provided, the new address will be automatically assigned as the customer's default address of that type.",
"type": {
"kind": "ENUM",
"name": "AddressTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountAddressCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accountAddressDelete",
"description": "Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.\n\nTriggers the following webhook events:\n- ADDRESS_DELETED (async): An address was deleted.",
"args": [
{
"name": "id",
"description": "ID of the address to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountAddressDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accountAddressUpdate",
"description": "Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.\n\nTriggers the following webhook events:\n- ADDRESS_UPDATED (async): An address was updated.",
"args": [
{
"name": "id",
"description": "ID of the address to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update the address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountAddressUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accountDelete",
"description": "Remove user account. \n\nRequires one of the following permissions: AUTHENTICATED_USER.",
"args": [
{
"name": "token",
"description": "A one-time token required to remove account. Sent by email using AccountRequestDeletion mutation.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accountRegister",
"description": "Register a new user.\n\nTriggers the following webhook events:\n- CUSTOMER_CREATED (async): A new customer account was created.\n- NOTIFY_USER (async): A notification for account confirmation.\n- ACCOUNT_CONFIRMATION_REQUESTED (async): An user confirmation was requested. This event is always sent regardless of settings.",
"args": [
{
"name": "input",
"description": "Fields required to create a user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AccountRegisterInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountRegister",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accountRequestDeletion",
"description": "Sends an email with the account removal link for the logged-in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for account delete request.",
"args": [
{
"name": "channel",
"description": "Slug of a channel which will be used to notify users. Optional when only one channel exists.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to delete their account. URL in RFC 1808 format.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountRequestDeletion",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accountSetDefaultAddress",
"description": "Sets a default address for the authenticated user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer's address was updated.",
"args": [
{
"name": "id",
"description": "ID of the address to set as default.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AddressTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountSetDefaultAddress",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "accountUpdate",
"description": "Updates the account of the logged-in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.",
"args": [
{
"name": "input",
"description": "Fields required to update the account of the logged-in user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AccountInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AccountUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addressCreate",
"description": "Creates user address. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- ADDRESS_CREATED (async): A new address was created.",
"args": [
{
"name": "input",
"description": "Fields required to create address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userId",
"description": "ID of a user to create address for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AddressCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addressDelete",
"description": "Deletes an address. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- ADDRESS_DELETED (async): An address was deleted.",
"args": [
{
"name": "id",
"description": "ID of the address to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AddressDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addressSetDefault",
"description": "Sets a default address for the given user. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer was updated.",
"args": [
{
"name": "addressId",
"description": "ID of the address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AddressTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userId",
"description": "ID of the user to change the address for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AddressSetDefault",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addressUpdate",
"description": "Updates an address. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- ADDRESS_UPDATED (async): An address was updated.",
"args": [
{
"name": "id",
"description": "ID of the address to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update the address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AddressUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appActivate",
"description": "Activate the app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_STATUS_CHANGED (async): An app was activated.",
"args": [
{
"name": "id",
"description": "ID of app to activate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppActivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appCreate",
"description": "Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_INSTALLED (async): An app was installed.",
"args": [
{
"name": "input",
"description": "Fields required to create a new app.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AppInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appDeactivate",
"description": "Deactivate the app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_STATUS_CHANGED (async): An app was deactivated.",
"args": [
{
"name": "id",
"description": "ID of app to deactivate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppDeactivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appDelete",
"description": "Deletes an app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_DELETED (async): An app was deleted.",
"args": [
{
"name": "id",
"description": "ID of an app to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appDeleteFailedInstallation",
"description": "Delete failed installation. \n\nRequires one of the following permissions: MANAGE_APPS.",
"args": [
{
"name": "id",
"description": "ID of failed installation to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppDeleteFailedInstallation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appFetchManifest",
"description": "Fetch and validate manifest. \n\nRequires one of the following permissions: MANAGE_APPS.",
"args": [
{
"name": "manifestUrl",
"description": "URL to app's manifest in JSON format.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppFetchManifest",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appInstall",
"description": "Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.",
"args": [
{
"name": "input",
"description": "Fields required to install a new app.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AppInstallInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppInstall",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appRetryInstall",
"description": "Retry failed installation of new app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_INSTALLED (async): An app was installed.",
"args": [
{
"name": "activateAfterInstallation",
"description": "Determine if app will be set active or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of failed installation.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppRetryInstall",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appTokenCreate",
"description": "Creates a new token. \n\nRequires one of the following permissions: MANAGE_APPS.",
"args": [
{
"name": "input",
"description": "Fields required to create a new auth token.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AppTokenInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppTokenCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appTokenDelete",
"description": "Deletes an authentication token assigned to app. \n\nRequires one of the following permissions: MANAGE_APPS.",
"args": [
{
"name": "id",
"description": "ID of an auth token to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppTokenDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appTokenVerify",
"description": "Verify provided app token.",
"args": [
{
"name": "token",
"description": "App token to verify.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppTokenVerify",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appUpdate",
"description": "Updates an existing app. \n\nRequires one of the following permissions: MANAGE_APPS.\n\nTriggers the following webhook events:\n- APP_UPDATED (async): An app was updated.",
"args": [
{
"name": "id",
"description": "ID of an app to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update an existing app.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AppInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "assignNavigation",
"description": "Assigns storefront's navigation menus. \n\nRequires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS.",
"args": [
{
"name": "menu",
"description": "ID of the menu.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "navigationType",
"description": "Type of the navigation bar to assign the menu to.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "NavigationType",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AssignNavigation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "assignWarehouseShippingZone",
"description": "Add shipping zone to given warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a warehouse to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZoneIds",
"description": "List of shipping zone IDs.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WarehouseShippingZoneAssign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeBulkCreate",
"description": "Creates attributes.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nTriggers the following webhook events:\n- ATTRIBUTE_CREATED (async): An attribute was created.",
"args": [
{
"name": "attributes",
"description": "Input list of products to create.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeBulkCreateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeBulkCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeBulkDelete",
"description": "Deletes attributes. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_DELETED (async): An attribute was deleted.",
"args": [
{
"name": "ids",
"description": "List of attribute IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeBulkTranslate",
"description": "Creates/updates translations for attributes.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translations",
"description": "List of attributes translations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeBulkTranslateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeBulkTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeCreate",
"description": "Creates an attribute.\n\nTriggers the following webhook events:\n- ATTRIBUTE_CREATED (async): An attribute was created.",
"args": [
{
"name": "input",
"description": "Fields required to create an attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeDelete",
"description": "Deletes an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_DELETED (async): An attribute was deleted.",
"args": [
{
"name": "externalReference",
"description": "External ID of an attribute to delete. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of an attribute to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeReorderValues",
"description": "Reorder the values of an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"args": [
{
"name": "attributeId",
"description": "ID of an attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moves",
"description": "The list of reordering operations for given attribute values.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeReorderValues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeTranslate",
"description": "Creates/updates translations for an attribute. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "Attribute ID or AttributeTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeUpdate",
"description": "Updates attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"args": [
{
"name": "externalReference",
"description": "External ID of an attribute to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of an attribute to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update an attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeValueBulkDelete",
"description": "Deletes values of attributes. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"args": [
{
"name": "ids",
"description": "List of attribute value IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeValueBulkTranslate",
"description": "Creates/updates translations for attributes values.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translations",
"description": "List of attribute values translations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueBulkTranslateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueBulkTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeValueCreate",
"description": "Creates a value for an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_CREATED (async): An attribute value was created.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"args": [
{
"name": "attribute",
"description": "Attribute to which value will be assigned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to create an AttributeValue.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeValueDelete",
"description": "Deletes a value of an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"args": [
{
"name": "externalReference",
"description": "External ID of a value to delete. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a value to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeValueTranslate",
"description": "Creates/updates translations for an attribute value. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "AttributeValue ID or AttributeValueTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributeValueUpdate",
"description": "Updates value of an attribute. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.\n\nTriggers the following webhook events:\n- ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated.\n- ATTRIBUTE_UPDATED (async): An attribute was updated.",
"args": [
{
"name": "externalReference",
"description": "External ID of an AttributeValue to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of an AttributeValue to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update an AttributeValue.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeValueUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categoryBulkDelete",
"description": "Deletes categories. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "ids",
"description": "List of category IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categoryCreate",
"description": "Creates a new category. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create a category.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CategoryInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "parent",
"description": "ID of the parent category. If empty, category will be top level category.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categoryDelete",
"description": "Deletes a category. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a category to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categoryTranslate",
"description": "Creates/updates translations for a category. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "Category ID or CategoryTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categoryUpdate",
"description": "Updates a category. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a category to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a category.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CategoryInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelActivate",
"description": "Activate a channel. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_STATUS_CHANGED (async): A channel was activated.",
"args": [
{
"name": "id",
"description": "ID of the channel to activate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ChannelActivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelCreate",
"description": "Creates new channel. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_CREATED (async): A channel was created.",
"args": [
{
"name": "input",
"description": "Fields required to create channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ChannelCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ChannelCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelDeactivate",
"description": "Deactivate a channel. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_STATUS_CHANGED (async): A channel was deactivated.",
"args": [
{
"name": "id",
"description": "ID of the channel to deactivate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ChannelDeactivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelDelete",
"description": "Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. \n\nRequires one of the following permissions: MANAGE_CHANNELS.\n\nTriggers the following webhook events:\n- CHANNEL_DELETED (async): A channel was deleted.",
"args": [
{
"name": "id",
"description": "ID of a channel to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to delete a channel.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ChannelDeleteInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ChannelDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelReorderWarehouses",
"description": "Reorder the warehouses of a channel.\n\nAdded in Saleor 3.7. \n\nRequires one of the following permissions: MANAGE_CHANNELS.",
"args": [
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moves",
"description": "The list of reordering operations for the given channel warehouses.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ChannelReorderWarehouses",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelUpdate",
"description": "Update a channel.\n\nRequires one of the following permissions: MANAGE_CHANNELS.\nRequires one of the following permissions when updating only orderSettings field: MANAGE_CHANNELS, MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- CHANNEL_UPDATED (async): A channel was updated.\n- CHANNEL_METADATA_UPDATED (async): Optionally triggered when public or private metadata is updated.",
"args": [
{
"name": "id",
"description": "ID of a channel to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ChannelUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ChannelUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutAddPromoCode",
"description": "Adds a gift card or a voucher to a checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "promoCode",
"description": "Gift card code or voucher code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutAddPromoCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutBillingAddressUpdate",
"description": "Update billing address in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "billingAddress",
"description": "The billing address of the checkout.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "validationRules",
"description": "The rules for changing validation for received billing address data.\n\nAdded in Saleor 3.5.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CheckoutAddressValidationRules",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutBillingAddressUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutComplete",
"description": "Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.\n- ORDER_CREATED (async): Triggered when order is created.\n- NOTIFY_USER (async): A notification for order placement.\n- NOTIFY_USER (async): A staff notification for order placement.\n- ORDER_UPDATED (async): Triggered when order received the update after placement.\n- ORDER_PAID (async): Triggered when newly created order is paid.\n- ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.\n- ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the checkout metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentData",
"description": "Client-side generated data required to finalize the payment.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storeSource",
"description": "Determines whether to store the payment source for future usage. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use checkoutPaymentCreate for this action.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutComplete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutCreate",
"description": "Create a new checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_CREATED (async): A checkout was created.",
"args": [
{
"name": "input",
"description": "Fields required to create checkout.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CheckoutCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutCreateFromOrder",
"description": "Create new checkout from existing order.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [
{
"name": "id",
"description": "ID of a order that will be used to create the checkout.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutCreateFromOrder",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutCustomerAttach",
"description": "Sets the customer as the owner of the checkout. \n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerId",
"description": "ID of customer to attach to checkout. Requires IMPERSONATE_USER permission when customerId is different than the logged-in user.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutCustomerAttach",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutCustomerDetach",
"description": "Removes the user assigned as the owner of the checkout. \n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutCustomerDetach",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutDeliveryMethodUpdate",
"description": "Updates the delivery method (shipping method or pick up point) of the checkout.\n\nAdded in Saleor 3.1.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one.\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "deliveryMethodId",
"description": "Delivery Method ID (`Warehouse` ID or `ShippingMethod` ID).",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutDeliveryMethodUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutEmailUpdate",
"description": "Updates email address in the existing checkout object.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "email.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutEmailUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutLanguageCodeUpdate",
"description": "Update language code in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "New language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutLanguageCodeUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutLineDelete",
"description": "Deletes a CheckoutLine.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineId",
"description": "ID of the checkout line to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutLineDelete",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `checkoutLinesDelete` instead."
},
{
"name": "checkoutLinesAdd",
"description": "Adds a checkout line to the existing checkout.If line was already in checkout, its quantity will be increased.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "A list of checkout lines, each containing information about an item in the checkout.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CheckoutLineInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutLinesAdd",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutLinesDelete",
"description": "Deletes checkout lines.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "linesIds",
"description": "A list of checkout lines.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutLinesDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutLinesUpdate",
"description": "Updates checkout line in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "A list of checkout lines, each containing information about an item in the checkout.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CheckoutLineUpdateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutLinesUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutPaymentCreate",
"description": "Create a new payment for given checkout.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Data required to create a new payment.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PaymentInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutPaymentCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutRemovePromoCode",
"description": "Remove a gift card or a voucher from a checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "promoCode",
"description": "Gift card code or voucher code.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "promoCodeId",
"description": "Gift card or voucher ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutRemovePromoCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutShippingAddressUpdate",
"description": "Update shipping address in the existing checkout.\n\nTriggers the following webhook events:\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "The mailing address to where the checkout will be shipped.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "validationRules",
"description": "The rules for changing validation for received shipping address data.\n\nAdded in Saleor 3.5.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CheckoutAddressValidationRules",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutShippingAddressUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutShippingMethodUpdate",
"description": "Updates the shipping method of the checkout.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout shipping method with the external one.\n- CHECKOUT_UPDATED (async): A checkout was updated.",
"args": [
{
"name": "checkoutId",
"description": "The ID of the checkout. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethodId",
"description": "Shipping method.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Checkout token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutShippingMethodUpdate",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `checkoutDeliveryMethodUpdate` instead."
},
{
"name": "collectionAddProducts",
"description": "Adds products to a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "collectionId",
"description": "ID of a collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of product IDs.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionAddProducts",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionBulkDelete",
"description": "Deletes collections. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "ids",
"description": "List of collection IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionChannelListingUpdate",
"description": "Manage collection's availability in channels. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a collection to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to create or update collection channel listings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionChannelListingUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionChannelListingUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionCreate",
"description": "Creates a new collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create a collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionDelete",
"description": "Deletes a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a collection to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionRemoveProducts",
"description": "Remove products from a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "collectionId",
"description": "ID of a collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of product IDs.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionRemoveProducts",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionReorderProducts",
"description": "Reorder the products of a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "collectionId",
"description": "ID of a collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moves",
"description": "The collection products position operations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MoveProductInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionReorderProducts",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionTranslate",
"description": "Creates/updates translations for a collection. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "Collection ID or CollectionTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionUpdate",
"description": "Updates a collection. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a collection to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a collection.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CollectionInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "confirmAccount",
"description": "Confirm user account with token sent by email during registration.\n\nTriggers the following webhook events:\n- ACCOUNT_CONFIRMED (async): Account was confirmed.",
"args": [
{
"name": "email",
"description": "E-mail of the user performing account confirmation.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "A one-time token required to confirm the account.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ConfirmAccount",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "confirmEmailChange",
"description": "Confirm the email change of the logged-in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- NOTIFY_USER (async): A notification that account email change was confirmed.",
"args": [
{
"name": "channel",
"description": "Slug of a channel which will be used to notify users. Optional when only one channel exists.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "A one-time token required to change the email.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ConfirmEmailChange",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createWarehouse",
"description": "Creates new warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create warehouse.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "WarehouseCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WarehouseCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerBulkDelete",
"description": "Deletes customers. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_DELETED (async): A customer account was deleted.",
"args": [
{
"name": "ids",
"description": "List of user IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CustomerBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerBulkUpdate",
"description": "Updates customers.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A customer account was updated.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.",
"args": [
{
"name": "customers",
"description": "Input list of customers to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CustomerBulkUpdateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CustomerBulkUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerCreate",
"description": "Creates a new customer. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_CREATED (async): A new customer account was created.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.\n- NOTIFY_USER (async): A notification for setting the password.",
"args": [
{
"name": "input",
"description": "Fields required to create a customer.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "UserCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CustomerCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerDelete",
"description": "Deletes a customer. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_DELETED (async): A customer account was deleted.",
"args": [
{
"name": "externalReference",
"description": "External ID of a customer to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a customer to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CustomerDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerUpdate",
"description": "Updates an existing customer. \n\nRequires one of the following permissions: MANAGE_USERS.\n\nTriggers the following webhook events:\n- CUSTOMER_UPDATED (async): A new customer account was updated.\n- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.",
"args": [
{
"name": "externalReference",
"description": "External ID of a customer to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a customer to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a customer.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CustomerInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CustomerUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deleteMetadata",
"description": "Delete metadata of an object. To use it, you need to have access to the modified object.",
"args": [
{
"name": "id",
"description": "ID or token (for Order and Checkout) of an object to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "keys",
"description": "Metadata keys to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DeleteMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deletePrivateMetadata",
"description": "Delete object's private metadata. To use it, you need to be an authenticated staff user or an app and have access to the modified object.",
"args": [
{
"name": "id",
"description": "ID or token (for Order and Checkout) of an object to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "keys",
"description": "Metadata keys to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DeletePrivateMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deleteWarehouse",
"description": "Deletes selected warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a warehouse to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WarehouseDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContentCreate",
"description": "Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create a digital content.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DigitalContentUploadInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of a product variant to upload digital content.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DigitalContentCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContentDelete",
"description": "Remove digital content assigned to given variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "variantId",
"description": "ID of a product variant with digital content to remove.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DigitalContentDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContentUpdate",
"description": "Update digital content. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to update a digital content.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DigitalContentInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of a product variant with digital content to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DigitalContentUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContentUrlCreate",
"description": "Generate new URL to digital content. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create a new url.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DigitalContentUrlCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DigitalContentUrlCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrderBulkDelete",
"description": "Deletes draft orders. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "ids",
"description": "List of draft order IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DraftOrderBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrderComplete",
"description": "Completes creating an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order that will be completed.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DraftOrderComplete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrderCreate",
"description": "Creates a new draft order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to create an order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DraftOrderCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DraftOrderCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrderDelete",
"description": "Deletes a draft order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "externalReference",
"description": "External ID of a product to delete. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a product to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DraftOrderDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrderLinesBulkDelete",
"description": "Deletes order lines. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "ids",
"description": "List of order lines IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DraftOrderLinesBulkDelete",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "draftOrderUpdate",
"description": "Updates a draft order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "externalReference",
"description": "External ID of a draft order to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a draft order to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update an order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "DraftOrderInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DraftOrderUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "eventDeliveryRetry",
"description": "Retries event delivery. \n\nRequires one of the following permissions: MANAGE_APPS.",
"args": [
{
"name": "id",
"description": "ID of the event delivery to retry.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "EventDeliveryRetry",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "exportGiftCards",
"description": "Export gift cards to csv file.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for the exported file.",
"args": [
{
"name": "input",
"description": "Fields required to export gift cards data.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ExportGiftCardsInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExportGiftCards",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "exportProducts",
"description": "Export products to csv file. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for the exported file.",
"args": [
{
"name": "input",
"description": "Fields required to export product data.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ExportProductsInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExportProducts",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalAuthenticationUrl",
"description": "Prepare external authentication URL for user by custom plugin.",
"args": [
{
"name": "input",
"description": "The data required by plugin to create external authentication url.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginId",
"description": "The ID of the authentication plugin.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExternalAuthenticationUrl",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalLogout",
"description": "Logout user by custom plugin.",
"args": [
{
"name": "input",
"description": "The data required by plugin to proceed the logout process.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginId",
"description": "The ID of the authentication plugin.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExternalLogout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalNotificationTrigger",
"description": "Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload.\n\nAdded in Saleor 3.1.",
"args": [
{
"name": "channel",
"description": "Channel slug. Saleor will send a notification within a provided channel. Please, make sure that necessary plugins are active.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Input for External Notification Trigger.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ExternalNotificationTriggerInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginId",
"description": "The ID of notification plugin.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExternalNotificationTrigger",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalObtainAccessTokens",
"description": "Obtain external access tokens for user by custom plugin.",
"args": [
{
"name": "input",
"description": "The data required by plugin to create authentication data.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginId",
"description": "The ID of the authentication plugin.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExternalObtainAccessTokens",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalRefresh",
"description": "Refresh user's access by custom plugin.",
"args": [
{
"name": "input",
"description": "The data required by plugin to proceed the refresh process.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginId",
"description": "The ID of the authentication plugin.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExternalRefresh",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalVerify",
"description": "Verify external authentication data by plugin.",
"args": [
{
"name": "input",
"description": "The data required by plugin to proceed the verification.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginId",
"description": "The ID of the authentication plugin.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExternalVerify",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fileUpload",
"description": "Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [
{
"name": "file",
"description": "Represents a file in a multipart request.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "FileUpload",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardActivate",
"description": "Activate a gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was activated.",
"args": [
{
"name": "id",
"description": "ID of a gift card to activate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardActivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardAddNote",
"description": "Adds note to the gift card.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_UPDATED (async): A gift card was updated.",
"args": [
{
"name": "id",
"description": "ID of the gift card to add a note for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to create a note for the gift card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "GiftCardAddNoteInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardAddNote",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardBulkActivate",
"description": "Activate gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was activated.",
"args": [
{
"name": "ids",
"description": "List of gift card IDs to activate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardBulkActivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardBulkCreate",
"description": "Create gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_CREATED (async): A gift card was created.\n- NOTIFY_USER (async): A notification for created gift card.",
"args": [
{
"name": "input",
"description": "Fields required to create gift cards.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "GiftCardBulkCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardBulkCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardBulkDeactivate",
"description": "Deactivate gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated.",
"args": [
{
"name": "ids",
"description": "List of gift card IDs to deactivate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardBulkDeactivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardBulkDelete",
"description": "Delete gift cards.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_DELETED (async): A gift card was deleted.",
"args": [
{
"name": "ids",
"description": "List of gift card IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardCreate",
"description": "Creates a new gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_CREATED (async): A gift card was created.\n- NOTIFY_USER (async): A notification for created gift card.",
"args": [
{
"name": "input",
"description": "Fields required to create a gift card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "GiftCardCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardDeactivate",
"description": "Deactivate a gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated.",
"args": [
{
"name": "id",
"description": "ID of a gift card to deactivate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardDeactivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardDelete",
"description": "Delete gift card.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_DELETED (async): A gift card was deleted.",
"args": [
{
"name": "id",
"description": "ID of the gift card to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardResend",
"description": "Resend a gift card.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for gift card resend.",
"args": [
{
"name": "input",
"description": "Fields required to resend a gift card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "GiftCardResendInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardResend",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardSettingsUpdate",
"description": "Update gift card settings. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [
{
"name": "input",
"description": "Fields required to update gift card settings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "GiftCardSettingsUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardSettingsUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardUpdate",
"description": "Update a gift card. \n\nRequires one of the following permissions: MANAGE_GIFT_CARD.\n\nTriggers the following webhook events:\n- GIFT_CARD_UPDATED (async): A gift card was updated.",
"args": [
{
"name": "id",
"description": "ID of a gift card to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a gift card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "GiftCardUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceCreate",
"description": "Creates a ready to send invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required when creating an invoice.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "InvoiceCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderId",
"description": "ID of the order related to invoice.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "InvoiceCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceDelete",
"description": "Deletes an invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of an invoice to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "InvoiceDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceRequest",
"description": "Request an invoice for the order using plugin. \n\nRequires one of the following permissions: MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- INVOICE_REQUESTED (async): An invoice was requested.",
"args": [
{
"name": "number",
"description": "Invoice number, if not provided it will be generated.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderId",
"description": "ID of the order related to invoice.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "InvoiceRequest",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceRequestDelete",
"description": "Requests deletion of an invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- INVOICE_DELETED (async): An invoice was requested to delete.",
"args": [
{
"name": "id",
"description": "ID of an invoice to request the deletion.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "InvoiceRequestDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceSendNotification",
"description": "Send an invoice notification to the customer. \n\nRequires one of the following permissions: MANAGE_ORDERS.\n\nTriggers the following webhook events:\n- INVOICE_SENT (async): A notification for invoice send\n- NOTIFY_USER (async): A notification for invoice send",
"args": [
{
"name": "id",
"description": "ID of an invoice to be sent.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "InvoiceSendNotification",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceUpdate",
"description": "Updates an invoice. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of an invoice to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields to use when updating an invoice.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "UpdateInvoiceInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "InvoiceUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuBulkDelete",
"description": "Deletes menus. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_DELETED (async): A menu was deleted.",
"args": [
{
"name": "ids",
"description": "List of menu IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuCreate",
"description": "Creates a new Menu. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_CREATED (async): A menu was created.",
"args": [
{
"name": "input",
"description": "Fields required to create a menu.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MenuCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuDelete",
"description": "Deletes a menu. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_DELETED (async): A menu was deleted.",
"args": [
{
"name": "id",
"description": "ID of a menu to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItemBulkDelete",
"description": "Deletes menu items. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_DELETED (async): A menu item was deleted.",
"args": [
{
"name": "ids",
"description": "List of menu item IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItemCreate",
"description": "Creates a new menu item. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_CREATED (async): A menu item was created.",
"args": [
{
"name": "input",
"description": "Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MenuItemCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItemDelete",
"description": "Deletes a menu item. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_DELETED (async): A menu item was deleted.",
"args": [
{
"name": "id",
"description": "ID of a menu item to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItemMove",
"description": "Moves items of menus. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_UPDATED (async): Optionally triggered when sort order or parent changed for menu item.",
"args": [
{
"name": "menu",
"description": "ID of the menu.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moves",
"description": "The menu position data.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MenuItemMoveInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemMove",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItemTranslate",
"description": "Creates/updates translations for a menu item. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "MenuItem ID or MenuItemTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItemUpdate",
"description": "Updates a menu item. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_ITEM_UPDATED (async): A menu item was updated.",
"args": [
{
"name": "id",
"description": "ID of a menu item to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MenuItemInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuUpdate",
"description": "Updates a menu. \n\nRequires one of the following permissions: MANAGE_MENUS.\n\nTriggers the following webhook events:\n- MENU_UPDATED (async): A menu was updated.",
"args": [
{
"name": "id",
"description": "ID of a menu to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a menu.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MenuInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderAddNote",
"description": "Adds note to the order.\n\nDEPRECATED: this mutation will be removed in Saleor 4.0. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to create a note for the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderAddNoteInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "ID of the order to add a note for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderAddNote",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `orderNoteAdd` instead."
},
{
"name": "orderBulkCancel",
"description": "Cancels orders. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "ids",
"description": "List of orders IDs to cancel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderBulkCancel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderBulkCreate",
"description": "Creates multiple orders.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS_IMPORT.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orders",
"description": "Input list of orders to create. Orders limit: 50.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockUpdatePolicy",
"description": "Determine how stock should be updated, while processing the order. DEFAULT: UPDATE - Only do update, if there is enough stocks.",
"type": {
"kind": "ENUM",
"name": "StockUpdatePolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderBulkCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderCancel",
"description": "Cancel an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order to cancel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderCancel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderCapture",
"description": "Capture an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "amount",
"description": "Amount of money to capture.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the order to capture.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderCapture",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderConfirm",
"description": "Confirms an unconfirmed order by changing status to unfulfilled. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of an order to confirm.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderConfirm",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderCreateFromCheckout",
"description": "Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS.\n\nAdded in Saleor 3.2.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.\n- ORDER_CREATED (async): Triggered when order is created.\n- NOTIFY_USER (async): A notification for order placement.\n- NOTIFY_USER (async): A staff notification for order placement.\n- ORDER_UPDATED (async): Triggered when order received the update after placement.\n- ORDER_PAID (async): Triggered when newly created order is paid.\n- ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.\n- ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.",
"args": [
{
"name": "id",
"description": "ID of a checkout that will be converted to an order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the checkout metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the checkout private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeCheckout",
"description": "Determines if checkout should be removed after creating an order. Default true.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "true",
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderCreateFromCheckout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderDiscountAdd",
"description": "Adds discount to the order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to create a discount for the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderDiscountCommonInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderId",
"description": "ID of an order to discount.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderDiscountAdd",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderDiscountDelete",
"description": "Remove discount from the order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "discountId",
"description": "ID of a discount to remove.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderDiscountDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderDiscountUpdate",
"description": "Update discount for the order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "discountId",
"description": "ID of a discount to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a discount for the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderDiscountCommonInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderDiscountUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderFulfill",
"description": "Creates new fulfillments for an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to create a fulfillment.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderFulfillInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "ID of the order to be fulfilled.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderFulfill",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderFulfillmentApprove",
"description": "Approve existing fulfillment.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "allowStockToBeExceeded",
"description": "True if stock could be exceeded.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a fulfillment to approve.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "notifyCustomer",
"description": "True if confirmation email should be send.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "FulfillmentApprove",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderFulfillmentCancel",
"description": "Cancels existing fulfillment and optionally restocks items. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of a fulfillment to cancel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to cancel a fulfillment.",
"type": {
"kind": "INPUT_OBJECT",
"name": "FulfillmentCancelInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "FulfillmentCancel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderFulfillmentRefundProducts",
"description": "Refund products. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to create an refund fulfillment.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderRefundProductsInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "ID of the order to be refunded.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "FulfillmentRefundProducts",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderFulfillmentReturnProducts",
"description": "Return products. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to return products.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderReturnProductsInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "ID of the order to be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "FulfillmentReturnProducts",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderFulfillmentUpdateTracking",
"description": "Updates a fulfillment for an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of a fulfillment to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a fulfillment.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "FulfillmentUpdateTrackingInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "FulfillmentUpdateTracking",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderGrantRefundCreate",
"description": "Adds granted refund to the order.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to create a granted refund for the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderGrantRefundCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderGrantRefundUpdate",
"description": "Updates granted refund.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the granted refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a granted refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderGrantRefundUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLineDelete",
"description": "Deletes an order line from an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order line to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderLineDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLineDiscountRemove",
"description": "Remove discount applied to the order line. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "orderLineId",
"description": "ID of a order line to remove its discount",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderLineDiscountRemove",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLineDiscountUpdate",
"description": "Update discount for the order line. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to update price for the order line.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderDiscountCommonInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLineId",
"description": "ID of a order line to update price",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderLineDiscountUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLineUpdate",
"description": "Updates an order line of an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order line to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update an order line.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderLineInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderLineUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLinesCreate",
"description": "Create order lines for an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order to add the lines to.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to add order lines.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderLineCreateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderLinesCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderMarkAsPaid",
"description": "Mark order as manually paid. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order to mark paid.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionReference",
"description": "The external transaction reference.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderMarkAsPaid",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderNoteAdd",
"description": "Adds note to the order.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to create a note for the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderNoteInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "ID of the order to add a note for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderNoteAdd",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderNoteUpdate",
"description": "Updates note of an order.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to create a note for the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderNoteInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "ID of the note.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderNoteUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderRefund",
"description": "Refund an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "amount",
"description": "Amount of money to refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the order to refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderRefund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderSettingsUpdate",
"description": "Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to update shop order settings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderSettingsUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderSettingsUpdate",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "\n\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `channelUpdate` mutation instead."
},
{
"name": "orderUpdate",
"description": "Updates an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "externalReference",
"description": "External ID of an order to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of an order to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update an order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderUpdateShipping",
"description": "Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "input",
"description": "Fields required to change shipping method of the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderUpdateShippingInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "ID of the order to update a shipping method.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderUpdateShipping",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderVoid",
"description": "Void an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the order to void.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderVoid",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageAttributeAssign",
"description": "Assign attributes to a given page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "attributeIds",
"description": "The IDs of the attributes to assign.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeId",
"description": "ID of the page type to assign the attributes into.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageAttributeAssign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageAttributeUnassign",
"description": "Unassign attributes from a given page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "attributeIds",
"description": "The IDs of the attributes to unassign.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeId",
"description": "ID of the page type from which the attributes should be unassign.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageAttributeUnassign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageBulkDelete",
"description": "Deletes pages. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"args": [
{
"name": "ids",
"description": "List of page IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageBulkPublish",
"description": "Publish pages. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"args": [
{
"name": "ids",
"description": "List of page IDs to (un)publish.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Determine if pages will be published or not.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageBulkPublish",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageCreate",
"description": "Creates a new page. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"args": [
{
"name": "input",
"description": "Fields required to create a page.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PageCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageDelete",
"description": "Deletes a page. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"args": [
{
"name": "id",
"description": "ID of a page to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageReorderAttributeValues",
"description": "Reorder page attribute values. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"args": [
{
"name": "attributeId",
"description": "ID of an attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moves",
"description": "The list of reordering operations for given attribute values.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageId",
"description": "ID of a page.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageReorderAttributeValues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTranslate",
"description": "Creates/updates translations for a page. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "Page ID or PageTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PageTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeBulkDelete",
"description": "Delete page types. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "ids",
"description": "List of page type IDs to delete",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTypeBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeCreate",
"description": "Create a new page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "input",
"description": "Fields required to create page type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PageTypeCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTypeCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeDelete",
"description": "Delete a page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "id",
"description": "ID of the page type to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTypeDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeReorderAttributes",
"description": "Reorder the attributes of a page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "moves",
"description": "The list of attribute reordering operations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeId",
"description": "ID of a page type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTypeReorderAttributes",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypeUpdate",
"description": "Update page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "id",
"description": "ID of the page type to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update page type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PageTypeUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTypeUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageUpdate",
"description": "Updates an existing page. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"args": [
{
"name": "id",
"description": "ID of a page to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a page.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PageInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "passwordChange",
"description": "Change the password of the logged in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.",
"args": [
{
"name": "newPassword",
"description": "New user password.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldPassword",
"description": "Current user password.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PasswordChange",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentCapture",
"description": "Captures the authorized payment amount. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "amount",
"description": "Transaction amount.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentId",
"description": "Payment ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PaymentCapture",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentCheckBalance",
"description": "Check payment balance.",
"args": [
{
"name": "input",
"description": "Fields required to check payment balance.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PaymentCheckBalanceInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PaymentCheckBalance",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentGatewayInitialize",
"description": "Initializes a payment gateway session. It triggers the webhook `PAYMENT_GATEWAY_INITIALIZE_SESSION`, to the requested `paymentGateways`. If `paymentGateways` is not provided, the webhook will be send to all subscribed payment gateways.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [
{
"name": "amount",
"description": "The amount requested for initializing the payment gateway. If not provided, the difference between checkout.total - transactions that are already processed will be send.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the checkout or order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentGateways",
"description": "List of payment gateways to initialize.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PaymentGatewayToInitialize",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PaymentGatewayInitialize",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentInitialize",
"description": "Initializes payment process when it is required by gateway.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gateway",
"description": "A gateway name used to initialize the payment.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentData",
"description": "Client-side generated data required to initialize the payment.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PaymentInitialize",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentRefund",
"description": "Refunds the captured payment amount. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "amount",
"description": "Transaction amount.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentId",
"description": "Payment ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PaymentRefund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentVoid",
"description": "Voids the authorized payment. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "paymentId",
"description": "Payment ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PaymentVoid",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroupCreate",
"description": "Create new permission group. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- PERMISSION_GROUP_CREATED (async)",
"args": [
{
"name": "input",
"description": "Input fields to create permission group.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PermissionGroupCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PermissionGroupCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroupDelete",
"description": "Delete permission group. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- PERMISSION_GROUP_DELETED (async)",
"args": [
{
"name": "id",
"description": "ID of the group to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PermissionGroupDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroupUpdate",
"description": "Update permission group. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- PERMISSION_GROUP_UPDATED (async)",
"args": [
{
"name": "id",
"description": "ID of the group to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Input fields to create permission group.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PermissionGroupUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PermissionGroupUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginUpdate",
"description": "Update plugin configuration. \n\nRequires one of the following permissions: MANAGE_PLUGINS.",
"args": [
{
"name": "channelId",
"description": "ID of a channel for which the data should be modified.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of plugin to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a plugin configuration.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PluginUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PluginUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productAttributeAssign",
"description": "Assign attributes to a given product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "operations",
"description": "The operations to perform.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductAttributeAssignInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeId",
"description": "ID of the product type to assign the attributes into.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductAttributeAssign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productAttributeAssignmentUpdate",
"description": "Update attributes assigned to product variant for given product type.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "operations",
"description": "The operations to perform.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductAttributeAssignmentUpdateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeId",
"description": "ID of the product type to assign the attributes into.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductAttributeAssignmentUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productAttributeUnassign",
"description": "Un-assign attributes from a given product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "attributeIds",
"description": "The IDs of the attributes to unassign.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeId",
"description": "ID of the product type from which the attributes should be unassigned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductAttributeUnassign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productBulkCreate",
"description": "Creates products.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "Input list of products to create.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductBulkCreateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductBulkCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productBulkDelete",
"description": "Deletes products. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "ids",
"description": "List of product IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productBulkTranslate",
"description": "Creates/updates translations for products.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.\n\nTriggers the following webhook events:\n- TRANSLATION_CREATED (async): Called when a translation was created.\n- TRANSLATION_UPDATED (async): Called when a translation was updated.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translations",
"description": "List of product translations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductBulkTranslateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductBulkTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productChannelListingUpdate",
"description": "Manage product's availability in channels. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a product to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to create or update product channel listings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductChannelListingUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductChannelListingUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productCreate",
"description": "Creates a new product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create a product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productDelete",
"description": "Deletes a product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "externalReference",
"description": "External ID of a product to delete. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a product to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMediaBulkDelete",
"description": "Deletes product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "ids",
"description": "List of product media IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductMediaBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMediaCreate",
"description": "Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create a product media.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductMediaCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductMediaCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMediaDelete",
"description": "Deletes a product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a product media to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductMediaDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMediaReorder",
"description": "Changes ordering of the product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "mediaIds",
"description": "IDs of a product media in the desired order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productId",
"description": "ID of product that media order will be altered.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductMediaReorder",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMediaUpdate",
"description": "Updates a product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a product media to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a product media.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductMediaUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductMediaUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productReorderAttributeValues",
"description": "Reorder product attribute values. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "attributeId",
"description": "ID of an attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moves",
"description": "The list of reordering operations for given attribute values.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productId",
"description": "ID of a product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductReorderAttributeValues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTranslate",
"description": "Creates/updates translations for a product. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "Product ID or ProductTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeBulkDelete",
"description": "Deletes product types. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "ids",
"description": "List of product type IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTypeBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeCreate",
"description": "Creates a new product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "input",
"description": "Fields required to create a product type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductTypeInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTypeCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeDelete",
"description": "Deletes a product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "id",
"description": "ID of a product type to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTypeDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeReorderAttributes",
"description": "Reorder the attributes of a product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "moves",
"description": "The list of attribute reordering operations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeId",
"description": "ID of a product type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The attribute type to reorder.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductAttributeType",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTypeReorderAttributes",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypeUpdate",
"description": "Updates an existing product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "id",
"description": "ID of a product type to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a product type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductTypeInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTypeUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productUpdate",
"description": "Updates an existing product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "externalReference",
"description": "External ID of a product to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantBulkCreate",
"description": "Creates product variants for a given product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "ID of the product to create the variants for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "Input list of product variants to create.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantBulkCreateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantBulkCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantBulkDelete",
"description": "Deletes product variants. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "ids",
"description": "List of product variant IDs to delete.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "skus",
"description": "List of product variant SKUs to delete.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantBulkTranslate",
"description": "Creates/updates translations for products variants.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.\n\nTriggers the following webhook events:\n- TRANSLATION_CREATED (async): A translation was created.\n- TRANSLATION_UPDATED (async): A translation was updated.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translations",
"description": "List of products variants translations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantBulkTranslateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantBulkTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantBulkUpdate",
"description": "Update multiple product variants.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "ID of the product to update the variants for.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "Input list of product variants to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantBulkUpdateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantBulkUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantChannelListingUpdate",
"description": "Manage product variant prices in channels. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a product variant to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "List of fields required to create or upgrade product variant channel listings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantChannelListingAddInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "SKU of a product variant to update.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantChannelListingUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantCreate",
"description": "Creates a new variant for a product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "input",
"description": "Fields required to create a product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantDelete",
"description": "Deletes a product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "externalReference",
"description": "External ID of a product variant to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a product variant to delete.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "SKU of a product variant to delete.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantPreorderDeactivate",
"description": "Deactivates product variant preorder. It changes all preorder allocation into regular allocation.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a variant which preorder should be deactivated.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantPreorderDeactivate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantReorder",
"description": "Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "moves",
"description": "The list of variant reordering operations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productId",
"description": "Id of product that variants order will be altered.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantReorder",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantReorderAttributeValues",
"description": "Reorder product variant attribute values. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "attributeId",
"description": "ID of an attribute.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "moves",
"description": "The list of reordering operations for given attribute values.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of a product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantReorderAttributeValues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantSetDefault",
"description": "Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "productId",
"description": "Id of a product that will have the default variant set.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "Id of a variant that will be set as default.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantSetDefault",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantStocksCreate",
"description": "Creates stocks for product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "stocks",
"description": "Input list of stocks to create.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StockInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of a product variant for which stocks will be created.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantStocksCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantStocksDelete",
"description": "Delete stocks from product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "sku",
"description": "SKU of product variant for which stocks will be deleted.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of product variant for which stocks will be deleted.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseIds",
"description": "Input list of warehouse IDs.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantStocksDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantStocksUpdate",
"description": "Update stocks for product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "sku",
"description": "SKU of product variant for which stocks will be updated.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "Input list of stocks to create or update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StockInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of a product variant for which stocks will be updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantStocksUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantTranslate",
"description": "Creates/updates translations for a product variant. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "ProductVariant ID or ProductVariantTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantUpdate",
"description": "Updates an existing variant for product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "externalReference",
"description": "External ID of a product variant to update. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a product to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "SKU of a product variant to update.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requestEmailChange",
"description": "Request email change of the logged in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for account email change.",
"args": [
{
"name": "channel",
"description": "Slug of a channel which will be used to notify users. Optional when only one channel exists.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "newEmail",
"description": "New user email.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "password",
"description": "User password.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to update the email address. URL in RFC 1808 format.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "RequestEmailChange",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "requestPasswordReset",
"description": "Sends an email with the account password modification link.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for password reset.",
"args": [
{
"name": "channel",
"description": "Slug of a channel which will be used for notify user. Optional when only one channel exists.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email of the user that will be used for password recovery.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to reset the password. URL in RFC 1808 format.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "RequestPasswordReset",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleBulkDelete",
"description": "Deletes sales. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_DELETED (async): A sale was deleted.",
"args": [
{
"name": "ids",
"description": "List of sale IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleCataloguesAdd",
"description": "Adds products, categories, collections to a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_UPDATED (async): A sale was updated.",
"args": [
{
"name": "id",
"description": "ID of a sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to modify catalogue IDs of sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CatalogueInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleAddCatalogues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleCataloguesRemove",
"description": "Removes products, categories, collections from a sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_UPDATED (async): A sale was updated.",
"args": [
{
"name": "id",
"description": "ID of a sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to modify catalogue IDs of sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CatalogueInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleRemoveCatalogues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleChannelListingUpdate",
"description": "Manage sale's availability in channels. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "id",
"description": "ID of a sale to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update sale channel listings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "SaleChannelListingInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleChannelListingUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleCreate",
"description": "Creates a new sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_CREATED (async): A sale was created.",
"args": [
{
"name": "input",
"description": "Fields required to create a sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "SaleInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleDelete",
"description": "Deletes a sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_DELETED (async): A sale was deleted.",
"args": [
{
"name": "id",
"description": "ID of a sale to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleTranslate",
"description": "Creates/updates translations for a sale. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "Sale ID or SaleTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleUpdate",
"description": "Updates a sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_UPDATED (async): A sale was updated.\n- SALE_TOGGLE (async): Optionally triggered when a sale is started or stopped.",
"args": [
{
"name": "id",
"description": "ID of a sale to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "SaleInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sendConfirmationEmail",
"description": "Sends a notification confirmation.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for account confirmation.\n- ACCOUNT_CONFIRMATION_REQUESTED (async): An account confirmation was requested. This event is always sent regardless of settings.",
"args": [
{
"name": "channel",
"description": "Slug of a channel which will be used for notify user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "Base of frontend URL that will be needed to create confirmation URL.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SendConfirmationEmail",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "setPassword",
"description": "Sets the user's password from the token sent by email using the RequestPasswordReset mutation.",
"args": [
{
"name": "email",
"description": "Email of a user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "password",
"description": "Password of a user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "A one-time token required to set the password.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SetPassword",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethodChannelListingUpdate",
"description": "Manage shipping method's availability in channels. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "id",
"description": "ID of a shipping method to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update shipping method channel listings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingMethodChannelListingInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodChannelListingUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPriceBulkDelete",
"description": "Deletes shipping prices. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "ids",
"description": "List of shipping price IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingPriceBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPriceCreate",
"description": "Creates a new shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "input",
"description": "Fields required to create a shipping price.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingPriceInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingPriceCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPriceDelete",
"description": "Deletes a shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "id",
"description": "ID of a shipping price to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingPriceDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPriceExcludeProducts",
"description": "Exclude products from shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "id",
"description": "ID of a shipping price.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Exclude products input.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingPriceExcludeProductsInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingPriceExcludeProducts",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPriceRemoveProductFromExclude",
"description": "Remove product from excluded list for shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "id",
"description": "ID of a shipping price.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products which will be removed from excluded list.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingPriceRemoveProductFromExclude",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPriceTranslate",
"description": "Creates/updates translations for a shipping method. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "ShippingMethodType ID or ShippingMethodTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingPriceTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingPriceTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPriceUpdate",
"description": "Updates a new shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "id",
"description": "ID of a shipping price to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a shipping price.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingPriceInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingPriceUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZoneBulkDelete",
"description": "Deletes shipping zones. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "ids",
"description": "List of shipping zone IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZoneBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZoneCreate",
"description": "Creates a new shipping zone. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "input",
"description": "Fields required to create a shipping zone.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingZoneCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZoneCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZoneDelete",
"description": "Deletes a shipping zone. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "id",
"description": "ID of a shipping zone to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZoneDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZoneUpdate",
"description": "Updates a new shipping zone. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "id",
"description": "ID of a shipping zone to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a shipping zone.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingZoneUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZoneUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopAddressUpdate",
"description": "Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [
{
"name": "input",
"description": "Fields required to update shop address.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShopAddressUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopDomainUpdate",
"description": "Updates site domain of the shop. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [
{
"name": "input",
"description": "Fields required to update site.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SiteDomainInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShopDomainUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopFetchTaxRates",
"description": "Fetch tax rates. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShopFetchTaxRates",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "\n\nDEPRECATED: this mutation will be removed in Saleor 4.0."
},
{
"name": "shopSettingsTranslate",
"description": "Creates/updates translations for shop settings. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "input",
"description": "Fields required to update shop settings translations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShopSettingsTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShopSettingsTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopSettingsUpdate",
"description": "Updates shop settings. \n\nRequires one of the following permissions: MANAGE_SETTINGS.\n\nTriggers the following webhook events:\n- SHOP_METADATA_UPDATED (async): Optionally triggered when public or private metadata is updated.",
"args": [
{
"name": "input",
"description": "Fields required to update shop settings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShopSettingsInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShopSettingsUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffBulkDelete",
"description": "Deletes staff users. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_DELETED (async): A staff account was deleted.",
"args": [
{
"name": "ids",
"description": "List of user IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StaffBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffCreate",
"description": "Creates a new staff user. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_CREATED (async): A new staff account was created.\n- NOTIFY_USER (async): A notification for setting the password.",
"args": [
{
"name": "input",
"description": "Fields required to create a staff user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StaffCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StaffCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffDelete",
"description": "Deletes a staff user. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_DELETED (async): A staff account was deleted.",
"args": [
{
"name": "id",
"description": "ID of a staff user to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StaffDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffNotificationRecipientCreate",
"description": "Creates a new staff notification recipient. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [
{
"name": "input",
"description": "Fields required to create a staff notification recipient.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StaffNotificationRecipientInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StaffNotificationRecipientCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffNotificationRecipientDelete",
"description": "Delete staff notification recipient. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [
{
"name": "id",
"description": "ID of a staff notification recipient to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StaffNotificationRecipientDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffNotificationRecipientUpdate",
"description": "Updates a staff notification recipient. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [
{
"name": "id",
"description": "ID of a staff notification recipient to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a staff notification recipient.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StaffNotificationRecipientInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StaffNotificationRecipientUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffUpdate",
"description": "Updates an existing staff user. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_UPDATED (async): A staff account was updated.",
"args": [
{
"name": "id",
"description": "ID of a staff user to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a staff user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StaffUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StaffUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockBulkUpdate",
"description": "Updates stocks for a given variant and warehouse.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "errorPolicy",
"description": "Policies of error handling. DEFAULT: REJECT_EVERYTHING",
"type": {
"kind": "ENUM",
"name": "ErrorPolicyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "Input list of stocks to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StockBulkUpdateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StockBulkUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassCreate",
"description": "Create a tax class.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"args": [
{
"name": "input",
"description": "Fields required to create a tax class.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TaxClassCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxClassCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassDelete",
"description": "Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"args": [
{
"name": "id",
"description": "ID of a tax class to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxClassDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassUpdate",
"description": "Update a tax class.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"args": [
{
"name": "id",
"description": "ID of the tax class.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a tax class.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TaxClassUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxClassUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxConfigurationUpdate",
"description": "Update tax configuration for a channel.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"args": [
{
"name": "id",
"description": "ID of the tax configuration.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update the tax configuration.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TaxConfigurationUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxConfigurationUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCountryConfigurationDelete",
"description": "Remove all tax class rates for a specific country.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"args": [
{
"name": "countryCode",
"description": "Country in which to update the tax class rates.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxCountryConfigurationDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCountryConfigurationUpdate",
"description": "Update tax class rates for a specific country.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"args": [
{
"name": "countryCode",
"description": "Country in which to update the tax class rates.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updateTaxClassRates",
"description": "List of tax rates per tax class to update. When `{taxClass: id, rate: null`} is passed, it deletes the rate object for given taxClass ID. When `{rate: Int}` is passed without a tax class, it updates the default tax class for this country.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TaxClassRateInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxCountryConfigurationUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxExemptionManage",
"description": "Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known.\n\nAdded in Saleor 3.8. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"args": [
{
"name": "id",
"description": "ID of the Checkout or Order object.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxExemption",
"description": "Determines if a taxes should be exempt.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxExemptionManage",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tokenCreate",
"description": "Create JWT token.",
"args": [
{
"name": "audience",
"description": "The audience that will be included to JWT tokens with prefix `custom:`.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email of a user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "password",
"description": "Password of a user.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CreateToken",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tokenRefresh",
"description": "Refresh JWT token. Mutation tries to take refreshToken from the input. If it fails it will try to take `refreshToken` from the http-only cookie `refreshToken`. `csrfToken` is required when `refreshToken` is provided as a cookie.",
"args": [
{
"name": "csrfToken",
"description": "CSRF token required to refresh token. This argument is required when `refreshToken` is provided as a cookie.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refreshToken",
"description": "Refresh token.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "RefreshToken",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tokenVerify",
"description": "Verify JWT token.",
"args": [
{
"name": "token",
"description": "JWT token to validate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VerifyToken",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tokensDeactivateAll",
"description": "Deactivate all JWT tokens of the currently authenticated user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DeactivateAllUserTokens",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionCreate",
"description": "Create transaction for checkout or order.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: HANDLE_PAYMENTS.",
"args": [
{
"name": "id",
"description": "The ID of the checkout or order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Input data required to create a new transaction object.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TransactionCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionEvent",
"description": "Data that defines a transaction event.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TransactionEventInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionEventReport",
"description": "Report the event for the transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app.",
"args": [
{
"name": "amount",
"description": "The amount of the event to report.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableActions",
"description": "List of all possible actions for the transaction",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionActionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalUrl",
"description": "The url that will allow to redirect user to payment provider page with event details.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the transaction.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The message related to the event.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pspReference",
"description": "PSP Reference of the event to report.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "time",
"description": "The time of the event to report. If not provide, the current time will be used.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Current status of the event to report.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionEventTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionEventReport",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionInitialize",
"description": "Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. \n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [
{
"name": "action",
"description": "The expected action called for the transaction. By default, the `channel.defaultTransactionFlowStrategy` will be used. The field can be used only by app that has `HANDLE_PAYMENTS` permission.",
"type": {
"kind": "ENUM",
"name": "TransactionFlowStrategyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amount",
"description": "The amount requested for initializing the payment gateway. If not provided, the difference between checkout.total - transactions that are already processed will be send.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the checkout or order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentGateway",
"description": "Payment gateway used to initialize the transaction.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "PaymentGatewayToInitialize",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionInitialize",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionProcess",
"description": "Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. \n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [
{
"name": "data",
"description": "The data that will be passed to the payment gateway.",
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the transaction to process.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionProcess",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionRequestAction",
"description": "Request an action for payment transaction.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: HANDLE_PAYMENTS.",
"args": [
{
"name": "actionType",
"description": "Determines the action type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionActionEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amount",
"description": "Transaction request amount. If empty for refund or capture, maximal possible amount will be used.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the transaction.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionRequestAction",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionRequestRefundForGrantedRefund",
"description": "Request a refund for payment transaction based on granted refund.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: HANDLE_PAYMENTS.",
"args": [
{
"name": "grantedRefundId",
"description": "The ID of the granted refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the transaction.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionRequestRefundForGrantedRefund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionUpdate",
"description": "Update transaction.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app.",
"args": [
{
"name": "id",
"description": "The ID of the transaction.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Input data required to create a new transaction object.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TransactionUpdateInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionEvent",
"description": "Data that defines a transaction transaction.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TransactionEventInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unassignWarehouseShippingZone",
"description": "Remove shipping zone from given warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a warehouse to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZoneIds",
"description": "List of shipping zone IDs.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WarehouseShippingZoneUnassign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updateMetadata",
"description": "Updates metadata of an object. To use it, you need to have access to the modified object.",
"args": [
{
"name": "id",
"description": "ID or token (for Order and Checkout) of an object to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update the object's metadata.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "UpdateMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatePrivateMetadata",
"description": "Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object.",
"args": [
{
"name": "id",
"description": "ID or token (for Order and Checkout) of an object to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update the object's metadata.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "UpdatePrivateMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updateWarehouse",
"description": "Updates given warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of a warehouse to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update warehouse.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "WarehouseUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WarehouseUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userAvatarDelete",
"description": "Deletes a user avatar. Only for staff members. \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "UserAvatarDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userAvatarUpdate",
"description": "Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"args": [
{
"name": "image",
"description": "Represents an image file in a multipart request.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "UserAvatarUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userBulkSetActive",
"description": "Activate or deactivate users. \n\nRequires one of the following permissions: MANAGE_USERS.",
"args": [
{
"name": "ids",
"description": "List of user IDs to activate/deactivate.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if users will be set active or not.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "UserBulkSetActive",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantMediaAssign",
"description": "Assign an media to a product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "mediaId",
"description": "ID of a product media to assign to a variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of a product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VariantMediaAssign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantMediaUnassign",
"description": "Unassign an media from a product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "mediaId",
"description": "ID of a product media to unassign from a variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "ID of a product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VariantMediaUnassign",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherBulkDelete",
"description": "Deletes vouchers. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_DELETED (async): A voucher was deleted.",
"args": [
{
"name": "ids",
"description": "List of voucher IDs to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherBulkDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherCataloguesAdd",
"description": "Adds products, categories, collections to a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"args": [
{
"name": "id",
"description": "ID of a voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to modify catalogue IDs of voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CatalogueInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherAddCatalogues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherCataloguesRemove",
"description": "Removes products, categories, collections from a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"args": [
{
"name": "id",
"description": "ID of a voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to modify catalogue IDs of voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CatalogueInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherRemoveCatalogues",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherChannelListingUpdate",
"description": "Manage voucher's availability in channels. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"args": [
{
"name": "id",
"description": "ID of a voucher to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update voucher channel listings.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "VoucherChannelListingInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherChannelListingUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherCreate",
"description": "Creates a new voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_CREATED (async): A voucher was created.",
"args": [
{
"name": "input",
"description": "Fields required to create a voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "VoucherInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherDelete",
"description": "Deletes a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_DELETED (async): A voucher was deleted.",
"args": [
{
"name": "id",
"description": "ID of a voucher to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherTranslate",
"description": "Creates/updates translations for a voucher. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "Voucher ID or VoucherTranslatableContent ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherTranslate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucherUpdate",
"description": "Updates a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"args": [
{
"name": "id",
"description": "ID of a voucher to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "VoucherInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookCreate",
"description": "Creates a new webhook subscription. \n\nRequires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.",
"args": [
{
"name": "input",
"description": "Fields required to create a webhook.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "WebhookCreateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WebhookCreate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookDelete",
"description": "Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. \n\nRequires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.",
"args": [
{
"name": "id",
"description": "ID of a webhook to delete.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WebhookDelete",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookDryRun",
"description": "Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"args": [
{
"name": "objectId",
"description": "The ID of an object to serialize.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "The subscription query that defines the webhook event and its payload.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WebhookDryRun",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookTrigger",
"description": "Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"args": [
{
"name": "objectId",
"description": "The ID of an object to serialize.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookId",
"description": "The ID of the webhook.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WebhookTrigger",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookUpdate",
"description": "Updates a webhook subscription. \n\nRequires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.",
"args": [
{
"name": "id",
"description": "ID of a webhook to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "input",
"description": "Fields required to update a webhook.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "WebhookUpdateInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WebhookUpdate",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "name",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "NavigationType",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MAIN",
"description": "Main storefront navigation.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SECONDARY",
"description": "Secondary storefront navigation.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Node",
"description": "An object with an ID",
"fields": [
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Allocation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "App",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppExtension",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AppToken",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValueTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValueTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CategoryTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CategoryTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CheckoutLine",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionChannelListing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CustomerEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DigitalContentUrl",
"ofType": null
},
{
"kind": "OBJECT",
"name": "EventDelivery",
"ofType": null
},
{
"kind": "OBJECT",
"name": "EventDeliveryAttempt",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ExportEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ExportFile",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
{
"kind": "OBJECT",
"name": "FulfillmentLine",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCardTag",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItemTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItemTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderDiscount",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductChannelListing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantChannelListing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleChannelListing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodChannelListing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodPostalCodeRule",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShopTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "StaffNotificationRecipient",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Stock",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TaxConfiguration",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Transaction",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionEvent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "User",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherChannelListing",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Webhook",
"ofType": null
}
]
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"description": null,
"fields": [
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
{
"kind": "OBJECT",
"name": "App",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CheckoutLine",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
{
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
},
{
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TaxConfiguration",
"ofType": null
},
{
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
{
"kind": "OBJECT",
"name": "User",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "Order",
"description": "Represents an order in the shop.",
"fields": [
{
"name": "actions",
"description": "List of actions that can be performed in the current state of an order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderAction",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "authorizeStatus",
"description": "The authorize status of the order.\n\nAdded in Saleor 3.4.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderAuthorizeStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableCollectionPoints",
"description": "Collection points that can be used for this order.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableShippingMethods",
"description": "Shipping methods that can be used with this order.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
},
"isDeprecated": true,
"deprecationReason": "Use `shippingMethods`, this field will be removed in 4.0"
},
{
"name": "billingAddress",
"description": "Billing address. The full data can be access for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_ORDERS, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canFinalize",
"description": "Informs whether a draft order can be finalized(turned into a regular order).",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeStatus",
"description": "The charge status of the order.\n\nAdded in Saleor 3.4.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderChargeStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutId",
"description": "ID of the checkout that the order was created from. \n\nAdded in Saleor 3.11.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collectionPointName",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerNote",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deliveryMethod",
"description": "The delivery method selected for this order.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "UNION",
"name": "DeliveryMethod",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discount",
"description": "Returns applied discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `discounts` field instead."
},
{
"name": "discountName",
"description": "Discount name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `discounts` field instead."
},
{
"name": "discounts",
"description": "List of all discounts assigned to the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderDiscount",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Determines whether checkout prices should include taxes when displayed in a storefront.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": "List of errors that occurred during order validation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "List of events associated with the order.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderEvent",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this order. \n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillments",
"description": "List of shipments for the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCards",
"description": "List of user gift cards.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "grantedRefunds",
"description": "List of granted refunds.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderGrantedRefund",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoices",
"description": "List of order invoices. Can be fetched for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_ORDERS, OWNER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Invoice",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPaid",
"description": "Informs if an order is fully paid.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isShippingRequired",
"description": "Returns True, if order requires shipping.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `languageCodeEnum` field to fetch the language code. "
},
{
"name": "languageCodeEnum",
"description": "Order language code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of order lines.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "number",
"description": "User-friendly number of an order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "origin",
"description": "The order origin.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderOriginEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "original",
"description": "The ID of the order that was the base for this order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentStatus",
"description": "Internal payment status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PaymentChargeStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentStatusDisplay",
"description": "User-friendly payment status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payments",
"description": "List of payments for the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "Shipping address. The full data can be access for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_ORDERS, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "Shipping method for this order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `deliveryMethod` instead."
},
{
"name": "shippingMethodName",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethods",
"description": "Shipping methods related to this order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPrice",
"description": "Total price of shipping.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClass",
"description": "Denormalized tax class assigned to the shipping method.\n\nAdded in Saleor 3.9.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClassMetadata",
"description": "Denormalized public metadata of the shipping method's tax class.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClassName",
"description": "Denormalized name of the tax class assigned to the shipping method.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClassPrivateMetadata",
"description": "Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxRate",
"description": "The shipping tax rate value.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderStatus",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "statusDisplay",
"description": "User-friendly order status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subtotal",
"description": "The sum of line prices not including shipping.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxExemption",
"description": "Returns True if order has to be exempt from taxes.\n\nAdded in Saleor 3.8.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `id` instead."
},
{
"name": "total",
"description": "Total amount of the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalAuthorizePending",
"description": "Total amount of ongoing authorize requests for the order's transactions.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalAuthorized",
"description": "Amount authorized for the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalBalance",
"description": "The difference between the paid and the order total amount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCancelPending",
"description": "Total amount of ongoing cancel requests for the order's transactions.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCanceled",
"description": "Amount canceled for the order.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCaptured",
"description": "Amount captured for the order. ",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `totalCharged` instead."
},
{
"name": "totalChargePending",
"description": "Total amount of ongoing charge requests for the order's transactions.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCharged",
"description": "Amount charged for the order.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalGrantedRefund",
"description": "Total amount of granted refund.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalRefundPending",
"description": "Total amount of ongoing refund requests for the order's transactions.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalRefunded",
"description": "Total refund amount for the order.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalRemainingGrant",
"description": "The difference amount between granted refund and the amounts that are pending and refunded.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackingClientId",
"description": "Google Analytics tracking client ID. This field will be removed in Saleor 4.0.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactions",
"description": "List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS.\n\nAdded in Saleor 3.4.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedDiscountName",
"description": "Translated discount name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `discounts` field instead. "
},
{
"name": "undiscountedTotal",
"description": "Undiscounted total amount of the order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User who placed the order. This field is set only for orders placed by authenticated users. Can be fetched for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_USERS, MANAGE_ORDERS, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userEmail",
"description": "Email address of the customer. The full data can be access for orders created in Saleor 3.2 and later, for other orders requires one of the following permissions: MANAGE_ORDERS, OWNER.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderAction",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CAPTURE",
"description": "Represents the capture action.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MARK_AS_PAID",
"description": "Represents a mark-as-paid action.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND",
"description": "Represents a refund action.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOID",
"description": "Represents a void action.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderAddNote",
"description": "Adds note to the order.\n\nDEPRECATED: this mutation will be removed in Saleor 4.0. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "event",
"description": "Order note created.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order with the note added.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderAddNoteInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "message",
"description": "Note message.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderAuthorizeStatusEnum",
"description": "Determine a current authorize status for order.\n\n We treat the order as fully authorized when the sum of authorized and charged funds\n cover the `order.total`-`order.totalGrantedRefund`.\n We treat the order as partially authorized when the sum of authorized and charged\n funds covers only part of the `order.total`-`order.totalGrantedRefund`.\n We treat the order as not authorized when the sum of authorized and charged funds is\n 0.\n\n NONE - the funds are not authorized\n PARTIAL - the funds that are authorized and charged don't cover fully the\n `order.total`-`order.totalGrantedRefund`\n FULL - the funds that are authorized and charged fully cover the\n `order.total`-`order.totalGrantedRefund`\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FULL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NONE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderBulkCancel",
"description": "Cancels orders. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderBulkCreate",
"description": "Creates multiple orders.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS_IMPORT.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderBulkCreateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the created orders.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderBulkCreateResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateDeliveryMethodInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "shippingMethodId",
"description": "The ID of the shipping method.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethodName",
"description": "The name of the shipping method.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPrice",
"description": "The price of the shipping.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TaxedMoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClassId",
"description": "The ID of the tax class.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClassMetadata",
"description": "Metadata of the tax class.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClassName",
"description": "The name of the tax class.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxClassPrivateMetadata",
"description": "Private metadata of the tax class.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingTaxRate",
"description": "Tax rate of the shipping.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseId",
"description": "The ID of the warehouse.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseName",
"description": "The name of the warehouse.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderBulkCreateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "OrderBulkCreateErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderBulkCreateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BULK_LIMIT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FUTURE_DATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCORRECT_CURRENCY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INSUFFICIENT_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_QUANTITY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "METADATA_KEY_REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NEGATIVE_INDEX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NON_EXISTING_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTE_LENGTH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_RELATED_ORDER_LINE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_LINE_FULFILLMENT_LINE_MISMATCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRICE_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TOO_MANY_IDENTIFIERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateFulfillmentInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "lines",
"description": "List of items informing how to fulfill the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateFulfillmentLineInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackingCode",
"description": "Fulfillment's tracking code.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateFulfillmentLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "orderLineIndex",
"description": "0-based index of order line, which the fulfillment line refers to.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of line items to be fulfilled from given warehouse.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantExternalReference",
"description": "The external ID of the product variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "The ID of the product variant.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantSku",
"description": "The SKU of the product variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "ID of the warehouse from which the item will be fulfilled.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "billingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of the channel associated with the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "The date, when the order was inserted to Saleor database.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerNote",
"description": "Note about customer.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deliveryMethod",
"description": "The delivery method selected for this order.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateDeliveryMethodInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discounts",
"description": "List of discounts.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderDiscountCommonInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Determines whether checkout prices should include taxes, when displayed in a storefront.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the order.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillments",
"description": "Fulfillments of the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateFulfillmentInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCards",
"description": "List of gift card codes associated with the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoices",
"description": "Invoices related to the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateInvoiceInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Order language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of order lines.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateOrderLineInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Metadata of the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "notes",
"description": "Notes related to the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateNoteInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Private metadata of the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view, where users should be redirected to see the order details.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "Shipping address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": "Status of the order.",
"type": {
"kind": "ENUM",
"name": "OrderStatus",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactions",
"description": "Transactions related to the order.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TransactionCreateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "Customer associated with the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateUserInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "Code of a voucher associated with the order.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the order in kg.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateInvoiceInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "createdAt",
"description": "The date, when the invoice was created.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Metadata of the invoice.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "number",
"description": "Invoice number.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Private metadata of the invoice.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL of the invoice to download.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateNoteInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "appId",
"description": "The app ID associated with the message.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "The date associated with the message.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Note message. Max characters: 255.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userEmail",
"description": "The user email associated with the message.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userExternalReference",
"description": "The user external ID associated with the message.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userId",
"description": "The user ID associated with the message.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateOrderLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "createdAt",
"description": "The date, when the order line was created.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isGiftCard",
"description": "Gift card flag.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isShippingRequired",
"description": "Determines whether shipping of the order line items is required.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Metadata of the order line.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Private metadata of the order line.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productName",
"description": "The name of the product.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Number of items in the order line",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassId",
"description": "The ID of the tax class.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassMetadata",
"description": "Metadata of the tax class.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassName",
"description": "The name of the tax class.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassPrivateMetadata",
"description": "Private metadata of the tax class.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxRate",
"description": "Tax rate of the order line.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPrice",
"description": "Price of the order line.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TaxedMoneyInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedProductName",
"description": "Translation of the product name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedVariantName",
"description": "Translation of the product variant name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "undiscountedTotalPrice",
"description": "Price of the order line excluding applied discount.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TaxedMoneyInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantExternalReference",
"description": "The external ID of the product variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "The ID of the product variant.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantName",
"description": "The name of the product variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantSku",
"description": "The SKU of the product variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The ID of the warehouse, where the line will be allocated.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderBulkCreateResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on create attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderBulkCreateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderBulkCreateUserInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "email",
"description": "Customer email associated with the order.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "Customer external ID associated with the order.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Customer ID associated with the order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderBulkCreated",
"description": "Event sent when orders are imported.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orders",
"description": "The orders the event relates to.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCancel",
"description": "Cancel an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Canceled order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCancelled",
"description": "Event sent when order is canceled.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCapture",
"description": "Capture an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Captured order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderChargeStatusEnum",
"description": "Determine the current charge status for the order.\n\n An order is considered overcharged when the sum of the\n transactionItem's charge amounts exceeds the value of\n `order.total` - `order.totalGrantedRefund`.\n If the sum of the transactionItem's charge amounts equals\n `order.total` - `order.totalGrantedRefund`, we consider the order to be fully\n charged.\n If the sum of the transactionItem's charge amounts covers a part of the\n `order.total` - `order.totalGrantedRefund`, we treat the order as partially charged.\n\n NONE - the funds are not charged.\n PARTIAL - the funds that are charged don't cover the\n `order.total`-`order.totalGrantedRefund`\n FULL - the funds that are charged fully cover the\n `order.total`-`order.totalGrantedRefund`\n OVERCHARGED - the charged funds are bigger than the\n `order.total`-`order.totalGrantedRefund`\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FULL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NONE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OVERCHARGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderConfirm",
"description": "Confirms an unconfirmed order by changing status to unfulfilled. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderConfirmed",
"description": "Event sent when order is confirmed.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCreateFromCheckout",
"description": "Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS.\n\nAdded in Saleor 3.2.\n\nTriggers the following webhook events:\n- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.\n- CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.\n- CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.\n- ORDER_CREATED (async): Triggered when order is created.\n- NOTIFY_USER (async): A notification for order placement.\n- NOTIFY_USER (async): A staff notification for order placement.\n- ORDER_UPDATED (async): Triggered when order received the update after placement.\n- ORDER_PAID (async): Triggered when newly created order is paid.\n- ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.\n- ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderCreateFromCheckoutError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Placed order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCreateFromCheckoutError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderCreateFromCheckoutErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of line Ids which cause the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "List of variant IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderCreateFromCheckoutErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BILLING_ADDRESS_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_NOT_APPLICABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INSUFFICIENT_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_SHIPPING_METHOD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_LINES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ADDRESS_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_METHOD_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAX_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNAVAILABLE_VARIANT_IN_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_NOT_APPLICABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderCreated",
"description": "Event sent when new order is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderDirection",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ASC",
"description": "Specifies an ascending sort order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DESC",
"description": "Specifies a descending sort order.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderDiscount",
"description": "Contains all details related to the applied discount to the order.",
"fields": [
{
"name": "amount",
"description": "Returns amount of discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of discount applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of applied discount.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Explanation for the applied discount.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedName",
"description": "Translated name of the applied discount.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of applied discount: Sale, Voucher or Manual.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDiscountType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of the discount. Can store fixed value or percent value",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueType",
"description": "Type of the discount: fixed or percent",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderDiscountAdd",
"description": "Adds discount to the order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which has been discounted.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderDiscountCommonInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "reason",
"description": "Explanation for the applied discount.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of the discount. Can store fixed value or percent value",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueType",
"description": "Type of the discount: fixed or percent",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderDiscountDelete",
"description": "Remove discount from the order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which has removed discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderDiscountType",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "MANUAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderDiscountUpdate",
"description": "Update discount for the order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which has been discounted.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderDraftFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channels",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customer",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderError",
"description": null,
"fields": [
{
"name": "addressType",
"description": "A type of address that causes the error.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AddressTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLines",
"description": "List of order line IDs that cause the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "List of product variants that are associated with the error",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "Warehouse ID which causes the error.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BILLING_ADDRESS_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_CANCEL_FULFILLMENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_CANCEL_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_DELETE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_DISCOUNT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_FULFILL_UNPAID_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_REFUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CAPTURE_INACTIVE_PAYMENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILL_ORDER_LINE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_LINE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INSUFFICIENT_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_QUANTITY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_AVAILABLE_IN_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_EDITABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_NO_SHIPPING_ADDRESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_MISSING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_NOT_PUBLISHED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_UNAVAILABLE_FOR_PURCHASE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_METHOD_NOT_APPLICABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_METHOD_REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAX_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOID_INACTIVE_PAYMENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ZERO_QUANTITY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderEvent",
"description": "History log of the order.",
"fields": [
{
"name": "amount",
"description": "Amount of money.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "app",
"description": "App that performed the action. Requires of of the following permissions: MANAGE_APPS, MANAGE_ORDERS, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "composedId",
"description": "Composed ID of the Fulfillment.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "date",
"description": "Date when event happened at in ISO 8601 format.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discount",
"description": "The discount applied to the order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderEventDiscountObject",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email of the customer.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "emailType",
"description": "Type of an email sent to the customer.",
"args": [],
"type": {
"kind": "ENUM",
"name": "OrderEventsEmailsEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfilledItems",
"description": "The lines fulfilled.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "FulfillmentLine",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "invoiceNumber",
"description": "Number of an invoice related to the order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "The concerned lines.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderEventOrderLineObject",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Content of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderNumber",
"description": "User-friendly number of an order.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oversoldItems",
"description": "List of oversold lines names.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentGateway",
"description": "The payment gateway of the payment.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentId",
"description": "The payment reference from the payment provider.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Number of items.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reference",
"description": "The reference of payment's transaction.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "related",
"description": "The order event which is related to this event.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "relatedOrder",
"description": "The order which is related to this order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingCostsIncluded",
"description": "Define if shipping costs were included to the refund.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionReference",
"description": "The transaction reference of captured payment.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Order event type.",
"args": [],
"type": {
"kind": "ENUM",
"name": "OrderEventsEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User who performed the action.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The warehouse were items were restocked.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderEventCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderEventCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderEventCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderEvent",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderEventDiscountObject",
"description": null,
"fields": [
{
"name": "amount",
"description": "Returns amount of discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldAmount",
"description": "Returns amount of discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldValue",
"description": "Value of the discount. Can store fixed value or percent value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oldValueType",
"description": "Type of the discount: fixed or percent.",
"args": [],
"type": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Explanation for the applied discount.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of the discount. Can store fixed value or percent value.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "valueType",
"description": "Type of the discount: fixed or percent.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderEventOrderLineObject",
"description": null,
"fields": [
{
"name": "discount",
"description": "The discount applied to the order line.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderEventDiscountObject",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "itemName",
"description": "The variant name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLine",
"description": "The order line.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The variant quantity.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderEventsEmailsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DIGITAL_LINKS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CONFIRMATION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CANCEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CONFIRMATION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_REFUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_CONFIRMATION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_CONFIRMATION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRACKING_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderEventsEnum",
"description": "The different order event types. ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ADDED_PRODUCTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCELED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_CREATED_FROM_REPLACE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL_SENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXTERNAL_SERVICE_NOTIFICATION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_AWAITS_APPROVAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CANCELED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_FULFILLED_ITEMS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_REPLACED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_RESTOCKED_ITEMS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_RETURNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_GENERATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_SENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTE_ADDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_DISCOUNT_ADDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_DISCOUNT_AUTOMATICALLY_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_DISCOUNT_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_DISCOUNT_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULLY_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_LINE_DISCOUNT_REMOVED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_LINE_DISCOUNT_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_LINE_PRODUCT_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_LINE_VARIANT_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_MARKED_AS_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_REPLACEMENT_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OTHER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OVERSOLD_ITEMS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_AUTHORIZED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_CAPTURED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_FAILED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_VOIDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PLACED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PLACED_FROM_DRAFT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REMOVED_PRODUCTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRACKING_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_CANCEL_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_CHARGE_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_EVENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_MARK_AS_PAID_FAILED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_REFUND_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATED_ADDRESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderExpired",
"description": "Event sent when order becomes expired.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "authorizeStatus",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderAuthorizeStatusEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeStatus",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderChargeStatusEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutIds",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customer",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardBought",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardUsed",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isClickAndCollect",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPreorder",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "numbers",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentStatus",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PaymentChargeStatusEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderStatusFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderFilterShippingMethods",
"description": "Filter shipping methods for order.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethods",
"description": "Shipping methods that can be used with this checkout.\n\nAdded in Saleor 3.6.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderFulfill",
"description": "Creates new fulfillments for an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillments",
"description": "List of created fulfillments.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Fulfillment",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Fulfilled order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderFulfillInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "allowStockToBeExceeded",
"description": "If true, then allow proceed fulfillment when stock is exceeded.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of items informing how to fulfill the order.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderFulfillLineInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "notifyCustomer",
"description": "If true, send an email notification to the customer.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackingNumber",
"description": "Fulfillment tracking number.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderFulfillLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "orderLineId",
"description": "The ID of the order line.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "List of stock items to create.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderFulfillStockInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderFulfillStockInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "quantity",
"description": "The number of line items to be fulfilled from given warehouse.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "ID of the warehouse from which the item will be fulfilled.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderFulfilled",
"description": "Event sent when order is fulfilled.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderFullyPaid",
"description": "Event sent when order is fully paid.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderFullyRefunded",
"description": "The order is fully refunded.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantRefundCreate",
"description": "Adds granted refund to the order.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderGrantRefundCreateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "grantedRefund",
"description": "Created granted refund.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderGrantedRefund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which has assigned new grant refund.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantRefundCreateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderGrantRefundCreateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of lines which cause the error.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderGrantRefundCreateLineError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderGrantRefundCreateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_COSTS_ALREADY_GRANTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amount",
"description": "Amount of the granted refund. If not provided, the amount will be calculated automatically based on provided `lines` and `grantRefundForShipping`.",
"type": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "grantRefundForShipping",
"description": "Determine if granted refund should include shipping costs.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "Lines to assign to granted refund.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundCreateLineInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Reason of the granted refund.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantRefundCreateLineError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderGrantRefundCreateLineErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineId",
"description": "The ID of the line related to the error.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderGrantRefundCreateLineErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QUANTITY_GREATER_THAN_AVAILABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundCreateLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The ID of the order line.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The quantity of line items to be marked to refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Reason of the granted refund for the line.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantRefundUpdate",
"description": "Updates granted refund.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderGrantRefundUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "grantedRefund",
"description": "Created granted refund.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderGrantedRefund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which has assigned updated grant refund.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantRefundUpdateError",
"description": null,
"fields": [
{
"name": "addLines",
"description": "List of lines to add which cause the error.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderGrantRefundUpdateLineError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderGrantRefundUpdateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeLines",
"description": "List of lines to remove which cause the error.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderGrantRefundUpdateLineError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderGrantRefundUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_COSTS_ALREADY_GRANTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addLines",
"description": "Lines to assign to granted refund.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundUpdateLineAddInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amount",
"description": "Amount of the granted refund. if not provided and `addLines` or `removeLines` or `grantRefundForShipping` is provided, amount will be calculated automatically.",
"type": {
"kind": "SCALAR",
"name": "Decimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "grantRefundForShipping",
"description": "Determine if granted refund should include shipping costs.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Reason of the granted refund.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeLines",
"description": "Lines to remove from granted refund.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderGrantRefundUpdateLineAddInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The ID of the order line.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The quantity of line items to be marked to refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Reason of the granted refund for the line.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantRefundUpdateLineError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderGrantRefundUpdateLineErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lineId",
"description": "The ID of the line related to the error.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderGrantRefundUpdateLineErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QUANTITY_GREATER_THAN_AVAILABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantedRefund",
"description": "The details of granted refund.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "amount",
"description": "Refund amount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "app",
"description": "App that performed the action.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": "Time of creation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "Lines assigned to the granted refund.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderGrantedRefundLine",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Reason of the refund.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingCostsIncluded",
"description": "If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Time of last update.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User who performed the action. Requires of of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderGrantedRefundLine",
"description": "Represents granted refund line.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLine",
"description": "Line of the order associated with this granted refund.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Number of items to refund.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reason",
"description": "Reason for refunding the line.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderLine",
"description": "Represents order line of particular order.",
"fields": [
{
"name": "allocations",
"description": "List of allocations across warehouses.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Allocation",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContentUrl",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "DigitalContentUrl",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isShippingRequired",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.\n\nAdded in Saleor 3.5.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.\n\nAdded in Saleor 3.5.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productName",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productSku",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariantId",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityFulfilled",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityToFulfill",
"description": "A quantity of items remaining to be fulfilled.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "Denormalized tax class of the product in this order line.\n\nAdded in Saleor 3.9.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassMetadata",
"description": "Denormalized public metadata of the tax class.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassName",
"description": "Denormalized name of the tax class.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassPrivateMetadata",
"description": "Denormalized private metadata of the tax class. Requires staff permissions to access.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxRate",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "thumbnail",
"description": null,
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPrice",
"description": "Price of the order line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedProductName",
"description": "Product name in the customer's language",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translatedVariantName",
"description": "Variant name in the customer's language",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "undiscountedUnitPrice",
"description": "Price of the single item in the order line without applied an order line discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitDiscount",
"description": "The discount applied to the single order line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitDiscountReason",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitDiscountType",
"description": "Type of the discount: fixed or percent",
"args": [],
"type": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitDiscountValue",
"description": "Value of the discount. Can store fixed value or percent value",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitPrice",
"description": "Price of the single item in the order line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variant",
"description": "A purchased product variant. Note: this field may be null if the variant has been removed from stock at all. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantName",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderLineCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "forceNewLine",
"description": "Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. \n\nAdded in Saleor 3.6.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Custom price of the item.When the line with the same variant will be provided multiple times, the last price will be used.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Number of variant items ordered.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "Product variant ID.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderLineDelete",
"description": "Deletes an order line from an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "A related order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "orderLine",
"description": "An order line that was deleted.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderLineDiscountRemove",
"description": "Remove discount applied to the order line. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which is related to line which has removed discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "orderLine",
"description": "Order line which has removed discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderLineDiscountUpdate",
"description": "Update discount for the order line. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order which is related to the discounted line.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "orderLine",
"description": "Order line which has been discounted.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "quantity",
"description": "Number of variant items ordered.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderLineUpdate",
"description": "Updates an order line of an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Related order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "orderLine",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderLinesCreate",
"description": "Create order lines for an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Related order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "orderLines",
"description": "List of added order lines.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderMarkAsPaid",
"description": "Mark order as manually paid. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order marked as paid.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderMetadataUpdated",
"description": "Event sent when order metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderNoteAdd",
"description": "Adds note to the order.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderNoteAddError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "event",
"description": "Order note created.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order with the note added.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderNoteAddError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "OrderNoteAddErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderNoteAddErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderNoteInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "message",
"description": "Note message.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderNoteUpdate",
"description": "Updates note of an order.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderNoteUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "event",
"description": "Order note updated.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order with the note updated.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderNoteUpdateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "ENUM",
"name": "OrderNoteUpdateErrorCode",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderNoteUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "UNION",
"name": "OrderOrCheckout",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
]
},
{
"kind": "ENUM",
"name": "OrderOriginEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BULK_CREATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REISSUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderPaid",
"description": "Payment has been made. The order may be partially or fully paid.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderRefund",
"description": "Refund an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "A refunded order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderRefundFulfillmentLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "fulfillmentLineId",
"description": "The ID of the fulfillment line to refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of items to be refunded.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderRefundLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "orderLineId",
"description": "The ID of the order line to refund.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of items to be refunded.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderRefundProductsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amountToRefund",
"description": "The total amount of refund when the value is provided manually.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentLines",
"description": "List of fulfilled lines to refund.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderRefundFulfillmentLineInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "includeShippingCosts",
"description": "If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLines",
"description": "List of unfulfilled lines to refund.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderRefundLineInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderRefunded",
"description": "The order received a refund. The order may be partially or fully refunded.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderReturnFulfillmentLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "fulfillmentLineId",
"description": "The ID of the fulfillment line to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of items to be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "replace",
"description": "Determines, if the line should be added to replace order.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderReturnLineInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "orderLineId",
"description": "The ID of the order line to return.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "The number of items to be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "replace",
"description": "Determines, if the line should be added to replace order.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderReturnProductsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amountToRefund",
"description": "The total amount of refund when the value is provided manually.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentLines",
"description": "List of fulfilled lines to return.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderReturnFulfillmentLineInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "includeShippingCosts",
"description": "If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderLines",
"description": "List of unfulfilled lines to return.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "OrderReturnLineInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refund",
"description": "If true, Saleor will call refund action for all lines.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderSettings",
"description": "Represents the channel-specific order settings.",
"fields": [
{
"name": "allowUnpaidOrders",
"description": "Determine if it is possible to place unpdaid order by calling `checkoutComplete` mutation.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticallyConfirmAllNewOrders",
"description": "When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticallyFulfillNonShippableGiftCard",
"description": "When enabled, all non-shippable gift card orders will be fulfilled automatically.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultTransactionFlowStrategy",
"description": "Determine the transaction flow strategy to be used. Include the selected option in the payload sent to the payment app, as a requested action for the transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionFlowStrategyEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deleteExpiredOrdersAfter",
"description": "The time in days after expired orders will be deleted.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Day",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expireOrdersAfter",
"description": "Expiration time in minutes. Default null - means do not expire any orders.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Minute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "markAsPaidStrategy",
"description": "Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid.\n`PAYMENT_FLOW` - [default option] creates the `Payment` object.\n`TRANSACTION_FLOW` - creates the `TransactionItem` object.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "MarkAsPaidStrategyEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderSettingsError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderSettingsErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderSettingsErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderSettingsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "allowUnpaidOrders",
"description": "Determine if it is possible to place unpdaid order by calling `checkoutComplete` mutation.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticallyConfirmAllNewOrders",
"description": "When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. By default set to True",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticallyFulfillNonShippableGiftCard",
"description": "When enabled, all non-shippable gift card orders will be fulfilled automatically. By defualt set to True.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultTransactionFlowStrategy",
"description": "Determine the transaction flow strategy to be used. Include the selected option in the payload sent to the payment app, as a requested action for the transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "ENUM",
"name": "TransactionFlowStrategyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deleteExpiredOrdersAfter",
"description": "The time in days after expired orders will be deleted.Allowed range is from 1 to 120.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "Day",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "expireOrdersAfter",
"description": "Expiration time in minutes. Default null - means do not expire any orders. Enter 0 or null to disable.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "Minute",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "markAsPaidStrategy",
"description": "Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid.\n`PAYMENT_FLOW` - [default option] creates the `Payment` object.\n`TRANSACTION_FLOW` - creates the `TransactionItem` object.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "ENUM",
"name": "MarkAsPaidStrategyEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderSettingsUpdate",
"description": "Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderSettingsError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderSettings",
"description": "Order settings.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderSettings",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderSettingsErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderSettingsError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderSettingsUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "automaticallyConfirmAllNewOrders",
"description": "When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. By default set to True",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticallyFulfillNonShippableGiftCard",
"description": "When enabled, all non-shippable gift card orders will be fulfilled automatically. By defualt set to True.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort orders by creation date. \n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATION_DATE",
"description": "Sort orders by creation date. \n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER",
"description": "Sort orders by customer.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_STATUS",
"description": "Sort orders by fulfillment status.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_MODIFIED_AT",
"description": "Sort orders by last modified at.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NUMBER",
"description": "Sort orders by number.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT",
"description": "Sort orders by payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RANK",
"description": "Sort orders by rank. Note: This option is available only with the `search` filter.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort orders.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort orders by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderStatus",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANCELED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXPIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_FULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_RETURNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RETURNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNCONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNFULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "OrderStatusFilter",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANCELED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_FULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "READY_TO_CAPTURE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "READY_TO_FULFILL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNCONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNFULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderUpdate",
"description": "Updates an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "billingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this order.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingAddress",
"description": "Shipping address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userEmail",
"description": "Email address of the customer.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderUpdateShipping",
"description": "Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Order with updated shipping method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "OrderUpdateShippingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "shippingMethod",
"description": "ID of the selected shipping method, pass null to remove currently assigned shipping method.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderUpdated",
"description": "Event sent when order is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The order the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "OrderVoid",
"description": "Void an order. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "A voided order.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "OrderError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Page",
"description": "A static page that can be manually added by a shop operator through the dashboard.",
"fields": [
{
"name": "attributes",
"description": "List of attributes assigned to this product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SelectedAttribute",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "content",
"description": "Content of the page.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "contentJson",
"description": "Content of the page.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `content` field instead."
},
{
"name": "created",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageType",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date."
},
{
"name": "publishedAt",
"description": "The page publication date.\n\nAdded in Saleor 3.3.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated page fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for page.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageAttributeAssign",
"description": "Assign attributes to a given page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "pageType",
"description": "The updated page type.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageAttributeUnassign",
"description": "Unassign attributes from a given page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "pageType",
"description": "The updated page type.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageBulkDelete",
"description": "Deletes pages. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageBulkPublish",
"description": "Publish pages. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageCreate",
"description": "Creates a new page. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "content",
"description": "Page content.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Determines if page is visible in the storefront.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageType",
"description": "ID of the page type that page belongs to.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": "Publication date. ISO 8601 standard. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedAt",
"description": "Publication date time. ISO 8601 standard.\n\nAdded in Saleor 3.3.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Page internal name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "Page title.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageCreated",
"description": "Event sent when new page is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "The page the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageDelete",
"description": "Deletes a page. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageDeleted",
"description": "Event sent when page is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "The page the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PageErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PageErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ATTRIBUTE_ALREADY_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypes",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageInfo",
"description": "The Relay compliant `PageInfo` type, containing data necessary to paginate this connection.",
"fields": [
{
"name": "endCursor",
"description": "When paginating forwards, the cursor to continue.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasNextPage",
"description": "When paginating forwards, are there more items?",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasPreviousPage",
"description": "When paginating backwards, are there more items?",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startCursor",
"description": "When paginating backwards, the cursor to continue.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "content",
"description": "Page content.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Determines if page is visible in the storefront.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": "Publication date. ISO 8601 standard. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedAt",
"description": "Publication date time. ISO 8601 standard.\n\nAdded in Saleor 3.3.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Page internal name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "Page title.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageReorderAttributeValues",
"description": "Reorder page attribute values. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "Page from which attribute values are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PageSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort pages by creation date.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATION_DATE",
"description": "Sort pages by creation date.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLICATION_DATE",
"description": "Sort pages by publication date.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLISHED_AT",
"description": "Sort pages by publication date.\n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SLUG",
"description": "Sort pages by slug.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TITLE",
"description": "Sort pages by title.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VISIBILITY",
"description": "Sort pages by visibility.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort pages.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort pages by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PageSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTranslatableContent",
"description": null,
"fields": [
{
"name": "attributeValues",
"description": "List of page content attribute values that can be translated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValueTranslatableContent",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "content",
"description": "Content of the page to translate.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "contentJson",
"description": "Content of the page.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `content` field instead."
},
{
"name": "id",
"description": "The ID of the page translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "A static page that can be manually added by a shop operator through the dashboard.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "seoDescription",
"description": "SEO description to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "SEO title to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "Page title to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated page fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for page.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTranslate",
"description": "Creates/updates translations for a page. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageTranslatableContent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTranslation",
"description": null,
"fields": [
{
"name": "content",
"description": "Translated content of the page.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "contentJson",
"description": "Translated description of the page.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `content` field instead."
},
{
"name": "id",
"description": "The ID of the page translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "Translated SEO description.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "Translated SEO title.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "Translated page title.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageTranslationInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "content",
"description": "Translated page content.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageType",
"description": "Represents a type of page. It defines what attributes are available to pages of this type.",
"fields": [
{
"name": "attributes",
"description": "Page attributes of that page type.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableAttributes",
"description": "Attributes that can be assigned to the page type.\n\nRequires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasPages",
"description": "Whether page type has pages assigned.\n\nRequires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeBulkDelete",
"description": "Delete page types. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageTypeCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeCreate",
"description": "Create a new page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "pageType",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageTypeCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addAttributes",
"description": "List of attribute IDs to be assigned to the page type.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the page type.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Page type slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeCreated",
"description": "Event sent when new page type is created.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageType",
"description": "The page type the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeDelete",
"description": "Delete a page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "pageType",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeDeleted",
"description": "Event sent when page type is deleted.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageType",
"description": "The page type the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageTypeFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeReorderAttributes",
"description": "Reorder the attributes of a page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "pageType",
"description": "Page type from which attributes are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PageTypeSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort page types by name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SLUG",
"description": "Sort page types by slug.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageTypeSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort page types.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort page types by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PageTypeSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeUpdate",
"description": "Update page type. \n\nRequires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "pageType",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PageTypeUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addAttributes",
"description": "List of attribute IDs to be assigned to the page type.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the page type.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeAttributes",
"description": "List of attribute IDs to be assigned to the page type.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Page type slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageTypeUpdated",
"description": "Event sent when page type is updated.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageType",
"description": "The page type the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageUpdate",
"description": "Updates an existing page. \n\nRequires one of the following permissions: MANAGE_PAGES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PageUpdated",
"description": "Event sent when page is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "The page the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PasswordChange",
"description": "Change the password of the logged in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance with a new password.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Payment",
"description": "Represents a payment of a given type.",
"fields": [
{
"name": "actions",
"description": "List of actions that can be performed in the current state of a payment.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderAction",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableCaptureAmount",
"description": "Maximum amount of money that can be captured.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableRefundAmount",
"description": "Maximum amount of money that can be refunded.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "capturedAmount",
"description": "Total amount captured for this payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeStatus",
"description": "Internal payment status.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PaymentChargeStatusEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkout",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "creditCard",
"description": "The details of the card used for this payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CreditCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerIpAddress",
"description": "IP address of the user who created the payment.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gateway",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "modified",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentMethodType",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "total",
"description": "Total amount of the payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactions",
"description": "List of all transactions within this payment.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Transaction",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentAuthorize",
"description": "Authorize payment.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Look up a payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentCapture",
"description": "Captures the authorized payment amount. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Updated payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentCaptureEvent",
"description": "Capture payment.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Look up a payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PaymentChargeStatusEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANCELLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULLY_CHARGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULLY_REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_CHARGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_CHARGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIALLY_REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PENDING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUSED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentCheckBalance",
"description": "Check payment balance.",
"fields": [
{
"name": "data",
"description": "Response from the gateway.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PaymentCheckBalanceInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "card",
"description": "Information about card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CardInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gatewayId",
"description": "An ID of a payment gateway to check.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "method",
"description": "Payment method name.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentConfirmEvent",
"description": "Confirm payment.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Look up a payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PaymentErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "List of variant IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PaymentErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "BALANCE_CHECK_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BILLING_ADDRESS_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_INACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_EMAIL_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_SHIPPING_METHOD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_SUPPORTED_GATEWAY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NO_CHECKOUT_LINES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PARTIAL_PAYMENT_NOT_ALLOWED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ADDRESS_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_METHOD_NOT_SET",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNAVAILABLE_VARIANT_IN_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PaymentFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "checkouts",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": "Filter by ids. \n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentGateway",
"description": "Available payment gateway backend with configuration necessary to setup client.",
"fields": [
{
"name": "config",
"description": "Payment gateway client configuration.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GatewayConfigLine",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currencies",
"description": "Payment gateway supported currencies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Payment gateway ID.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Payment gateway name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentGatewayConfig",
"description": null,
"fields": [
{
"name": "data",
"description": "The JSON data required to initialize the payment gateway.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentGatewayConfigError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The app identifier.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentGatewayConfigError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PaymentGatewayConfigErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PaymentGatewayConfigErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentGatewayInitialize",
"description": "Initializes a payment gateway session. It triggers the webhook `PAYMENT_GATEWAY_INITIALIZE_SESSION`, to the requested `paymentGateways`. If `paymentGateways` is not provided, the webhook will be send to all subscribed payment gateways.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentGatewayInitializeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gatewayConfigs",
"description": null,
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentGatewayConfig",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentGatewayInitializeError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PaymentGatewayInitializeErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PaymentGatewayInitializeErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentGatewayInitializeSession",
"description": "Event sent when user wants to initialize the payment gateway.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "amount",
"description": "Amount requested for initializing the payment gateway.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "data",
"description": "Payment gateway data in JSON format, recieved from storefront.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceObject",
"description": "Checkout or order",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "OrderOrCheckout",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PaymentGatewayToInitialize",
"description": null,
"fields": null,
"inputFields": [
{
"name": "data",
"description": "The data that will be passed to the payment gateway.",
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The identifier of the payment gateway app to initialize.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentInitialize",
"description": "Initializes payment process when it is required by gateway.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "initializedPayment",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "PaymentInitialized",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentInitialized",
"description": "Server-side data generated by a payment gateway. Optional step when the payment provider requires an additional action to initialize payment session.",
"fields": [
{
"name": "data",
"description": "Initialized data by gateway.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gateway",
"description": "ID of a payment gateway.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Payment gateway name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PaymentInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amount",
"description": "Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gateway",
"description": "A gateway to use with that payment.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "User public metadata.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "returnUrl",
"description": "URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storePaymentMethod",
"description": "Payment store type.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "ENUM",
"name": "StorePaymentMethodEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "Client-side generated payment token, representing customer's billing data in a secure manner.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentListGateways",
"description": "List payment gateways.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "checkout",
"description": "The checkout the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentProcessEvent",
"description": "Process payment.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Look up a payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentRefund",
"description": "Refunds the captured payment amount. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Updated payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentRefundEvent",
"description": "Refund payment.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Look up a payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentSource",
"description": "Represents a payment source stored for user in payment gateway, such as credit card.",
"fields": [
{
"name": "creditCardInfo",
"description": "Stored credit card details if available.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CreditCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gateway",
"description": "Payment gateway name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items.\n\nAdded in Saleor 3.1.\n\nCan be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentMethodId",
"description": "ID of stored payment method.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentVoid",
"description": "Voids the authorized payment. \n\nRequires one of the following permissions: MANAGE_ORDERS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Updated payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "paymentErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PaymentVoidEvent",
"description": "Void payment.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Look up a payment.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Permission",
"description": "Represents a permission object in a friendly form.",
"fields": [
{
"name": "code",
"description": "Internal code for permission.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Describe action(s) allowed to do by permission.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PermissionEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "HANDLE_CHECKOUTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HANDLE_PAYMENTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "HANDLE_TAXES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "IMPERSONATE_USER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_APPS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_CHANNELS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_CHECKOUTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_DISCOUNTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_GIFT_CARD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_MENUS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_OBSERVABILITY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_ORDERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_ORDERS_IMPORT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_PAGES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_PAGE_TYPES_AND_ATTRIBUTES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_PLUGINS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_PRODUCTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_SETTINGS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_SHIPPING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_STAFF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_TAXES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_TRANSLATIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MANAGE_USERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupCreate",
"description": "Create new permission group. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- PERMISSION_GROUP_CREATED (async)",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PermissionGroupError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "group",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroupErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PermissionGroupError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PermissionGroupCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to assign to this group.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addPermissions",
"description": "List of permission code names to assign to this group.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addUsers",
"description": "List of users to assign to this group.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Group name.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restrictedAccessToChannels",
"description": "Determine if the group has restricted access to channels. DEFAULT: False\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupCreated",
"description": "Event sent when new permission group is created.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroup",
"description": "The permission group the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupDelete",
"description": "Delete permission group. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- PERMISSION_GROUP_DELETED (async)",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PermissionGroupError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "group",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroupErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PermissionGroupError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupDeleted",
"description": "Event sent when permission group is deleted.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroup",
"description": "The permission group the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupError",
"description": null,
"fields": [
{
"name": "channels",
"description": "List of chnnels IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionGroupErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of permissions which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "users",
"description": "List of user IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PermissionGroupErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ASSIGN_NON_STAFF_MEMBER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_REMOVE_FROM_LAST_GROUP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LEFT_NOT_MANAGEABLE_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_SCOPE_USER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PermissionGroupFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PermissionGroupSortField",
"description": "Sorting options for permission groups.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort permission group accounts by name.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PermissionGroupSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort permission group.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort permission group by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionGroupSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupUpdate",
"description": "Update permission group. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- PERMISSION_GROUP_UPDATED (async)",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PermissionGroupError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "group",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroupErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PermissionGroupError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PermissionGroupUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to assign to this group.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addPermissions",
"description": "List of permission code names to assign to this group.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addUsers",
"description": "List of users to assign to this group.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Group name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeChannels",
"description": "List of channels to unassign from this group.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removePermissions",
"description": "List of permission code names to unassign from this group.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeUsers",
"description": "List of users to unassign from this group.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restrictedAccessToChannels",
"description": "Determine if the group has restricted access to channels.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PermissionGroupUpdated",
"description": "Event sent when permission group is updated.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroup",
"description": "The permission group the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Plugin",
"description": "Plugin.",
"fields": [
{
"name": "channelConfigurations",
"description": "Channel-specific plugin configuration.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PluginConfiguration",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the plugin.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "globalConfiguration",
"description": "Global configuration of the plugin (not channel-specific).",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PluginConfiguration",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Identifier of the plugin.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the plugin.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PluginConfiguration",
"description": "Stores information about a configuration of plugin.",
"fields": [
{
"name": "active",
"description": "Determines if plugin is active or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "The channel to which the plugin configuration is assigned to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "configuration",
"description": "Configuration of the plugin.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ConfigurationItem",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PluginConfigurationType",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GLOBAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PER_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PluginCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PluginCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PluginCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Plugin",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PluginError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PluginErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PluginErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PLUGIN_MISCONFIGURED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PluginFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "statusInChannels",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "PluginStatusInChannelsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": null,
"type": {
"kind": "ENUM",
"name": "PluginConfigurationType",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PluginSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "IS_ACTIVE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PluginSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort plugins.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort plugins by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PluginSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PluginStatusInChannelsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "active",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PluginUpdate",
"description": "Update plugin configuration. \n\nRequires one of the following permissions: MANAGE_PLUGINS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PluginError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plugin",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Plugin",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pluginsErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PluginError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PluginUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "active",
"description": "Indicates whether the plugin should be enabled.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "configuration",
"description": "Configuration of the plugin.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ConfigurationItemInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "PositiveDecimal",
"description": "Nonnegative Decimal scalar implementation.\n\nShould be used in places where value must be nonnegative (0 or greater).",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "PostalCodeRuleInclusionTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "EXCLUDE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCLUDE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PreorderData",
"description": "Represents preorder settings for product variant.",
"fields": [
{
"name": "endDate",
"description": "Preorder end date.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "globalSoldUnits",
"description": "Total number of sold product variant during preorder.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "globalThreshold",
"description": "The global preorder threshold for product variant.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PreorderSettingsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "endDate",
"description": "The end date for preorder.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "globalThreshold",
"description": "The global threshold for preorder variant.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "PreorderThreshold",
"description": "Represents preorder variant data for channel.",
"fields": [
{
"name": "quantity",
"description": "Preorder threshold for product variant in this channel.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "soldUnits",
"description": "Number of sold product variant in this channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PriceInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amount",
"description": "Amount of money.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PriceRangeInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "gte",
"description": "Price greater than or equal to.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lte",
"description": "Price less than or equal to.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Product",
"description": "Represents an individual item for sale in the storefront.",
"fields": [
{
"name": "attribute",
"description": "Get a single attribute attached to product by attribute slug.\n\nAdded in Saleor 3.9.",
"args": [
{
"name": "slug",
"description": "Slug of the attribute",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SelectedAttribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributes",
"description": "List of attributes assigned to this product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SelectedAttribute",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableForPurchase",
"description": "Date when product is available for purchase.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date."
},
{
"name": "availableForPurchaseAt",
"description": "Date when product is available for purchase.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "category",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Channel given to retrieve this product. Also used by federation gateway to resolve this object in a federated query.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of availability in channels for the product.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductChannelListing",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeTaxes",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` field to determine whether tax collection is enabled."
},
{
"name": "collections",
"description": "List of collections for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": "The date and time when the product was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultVariant",
"description": "Default variant of the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the product.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Description of the product.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "externalReference",
"description": "External ID of this product. \n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "imageById",
"description": "Get a single product image by ID.",
"args": [
{
"name": "id",
"description": "ID of a product image.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductImage",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `mediaById` field instead."
},
{
"name": "images",
"description": "List of images for the product.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductImage",
"ofType": null
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `media` field instead."
},
{
"name": "isAvailable",
"description": "Whether the product is in stock, set as available for purchase in the given channel, and published.",
"args": [
{
"name": "address",
"description": "Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isAvailableForPurchase",
"description": "Refers to a state that can be set by admins to control whether a product is available for purchase in storefronts. This does not guarantee the availability of stock. When set to `False`, this product is still visible to customers, but it cannot be purchased.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": "List of media for the product.",
"args": [
{
"name": "sortBy",
"description": "Sort media. \n\nAdded in Saleor 3.9.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MediaSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "mediaById",
"description": "Get a single product media by ID.",
"args": [
{
"name": "id",
"description": "ID of a product media.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "SEO description of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pricing",
"description": "Lists the storefront product's pricing, the current price and discounts, only meant for displaying.",
"args": [
{
"name": "address",
"description": "Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductPricingInfo",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productType",
"description": "Type of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rating",
"description": "Rating of the product.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "SEO description of the product.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "SEO title of the product.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "Tax class assigned to this product type. All products of this product type use this tax class, unless it's overridden in the `Product` type.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxType",
"description": "A type of tax. Assigned by enabled tax gateway",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxType",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `taxClass` field instead."
},
{
"name": "thumbnail",
"description": "Thumbnail of the product.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated product fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The date and time when the product was last updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variant",
"description": "Get a single variant by SKU or ID. \n\nAdded in Saleor 3.9.",
"args": [
{
"name": "id",
"description": "ID of the variant.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "SKU of the variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use top-level `variant` query."
},
{
"name": "variants",
"description": "List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductAttributeAssign",
"description": "Assign attributes to a given product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productType",
"description": "The updated product type.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductAttributeAssignInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The ID of the attribute to assign.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The attribute type to be assigned as.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductAttributeType",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantSelection",
"description": "Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric'].\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductAttributeAssignmentUpdate",
"description": "Update attributes assigned to product variant for given product type.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productType",
"description": "The updated product type.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductAttributeAssignmentUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The ID of the attribute to assign.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantSelection",
"description": "Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric'].\n\nAdded in Saleor 3.1.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductAttributeType",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PRODUCT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductAttributeUnassign",
"description": "Un-assign attributes from a given product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productType",
"description": "The updated product type.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductBulkCreate",
"description": "Creates products.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductBulkCreateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the created products.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductBulkResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductBulkCreateError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": "List of channel IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductBulkCreateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouse IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductBulkCreateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ATTRIBUTE_ALREADY_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_CANNOT_BE_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VARIANTS_DISABLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "BLANK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_PRICE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAX_LENGTH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_NOT_ASSIGNED_TO_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_WITHOUT_CATEGORY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNSUPPORTED_MEDIA_PROVIDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductBulkCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "category",
"description": "ID of the product's category.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of channels in which the product is available.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductChannelListingCreateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeTaxes",
"description": "Determine if taxes are being charged for the product. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "List of IDs of collections that the product belongs to.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Product description.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": "List of media inputs associated with the product.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MediaInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the product metadata.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Product name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the product private metadata.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productType",
"description": "ID of the type that product belongs to.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rating",
"description": "Defines the product rating value.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Product slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "ID of a tax class to assign to this product. If not provided, product will use the tax class which is assigned to the product type.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCode",
"description": "Tax rate for enabled tax gateway. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "Input list of product variants to create.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantBulkCreateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the Product.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductBulkDelete",
"description": "Deletes products. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductBulkResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on create attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductBulkCreateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "Product data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductBulkTranslate",
"description": "Creates/updates translations for products.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.\n\nTriggers the following webhook events:\n- TRANSLATION_CREATED (async): Called when a translation was created.\n- TRANSLATION_UPDATED (async): Called when a translation was updated.",
"fields": [
{
"name": "count",
"description": "Returns how many translations were created/updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductBulkTranslateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the translations.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductBulkTranslateResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductBulkTranslateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductTranslateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductBulkTranslateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "externalReference",
"description": "External reference of an product.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Product ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationFields",
"description": "Translation fields.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductBulkTranslateResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on translation attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductBulkTranslateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Product translation data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductChannelListing",
"description": "Represents product channel listing.",
"fields": [
{
"name": "availableForPurchase",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date."
},
{
"name": "availableForPurchaseAt",
"description": "The product available for purchase date time.\n\nAdded in Saleor 3.3.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "The channel in which the product is listed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountedPrice",
"description": "The price of the cheapest variant (including discounts).",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the product channel listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isAvailableForPurchase",
"description": "Refers to a state that can be set by admins to control whether a product is available for purchase in storefronts in this channel. This does not guarantee the availability of stock. When set to `False`, this product is still visible to customers, but it cannot be purchased.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Indicates if the product is published in the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "margin",
"description": "Range of margin percentage value.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Margin",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pricing",
"description": "Lists the storefront product's pricing, the current price and discounts, only meant for displaying.",
"args": [
{
"name": "address",
"description": "Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductPricingInfo",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date."
},
{
"name": "publishedAt",
"description": "The product publication date time.\n\nAdded in Saleor 3.3.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "purchaseCost",
"description": "Purchase cost of product.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyRange",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInListings",
"description": "Indicates product visibility in the channel listings.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductChannelListingAddInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addVariants",
"description": "List of variants to which the channel should be assigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableForPurchaseAt",
"description": "A start date time from which a product will be available for purchase. When not set and `isAvailable` is set to True, the current day is assumed.\n\nAdded in Saleor 3.3.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableForPurchaseDate",
"description": "A start date from which a product will be available for purchase. When not set and isAvailable is set to True, the current day is assumed. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `availableForPurchaseAt` field instead.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isAvailableForPurchase",
"description": "Determines if product should be available for purchase in this channel. This does not guarantee the availability of stock. When set to `False`, this product is still visible to customers, but it cannot be purchased.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Determines if object is visible to customers.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": "Publication date. ISO 8601 standard. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedAt",
"description": "Publication date time. ISO 8601 standard.\n\nAdded in Saleor 3.3.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeVariants",
"description": "List of variants from which the channel should be unassigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInListings",
"description": "Determines if product is visible in product listings (doesn't apply to product collections).",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductChannelListingCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "availableForPurchaseAt",
"description": "A start date time from which a product will be available for purchase. When not set and `isAvailable` is set to True, the current day is assumed.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isAvailableForPurchase",
"description": "Determines if product should be available for purchase in this channel. This does not guarantee the availability of stock. When set to `False`, this product is still visible to customers, but it cannot be purchased.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Determines if object is visible to customers.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedAt",
"description": "Publication date time. ISO 8601 standard.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "visibleInListings",
"description": "Determines if product is visible in product listings (doesn't apply to product collections).",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductChannelListingError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": "List of channels IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "List of variants IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductChannelListingUpdate",
"description": "Manage product's availability in channels. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductChannelListingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "An updated product instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productChannelListingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductChannelListingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductChannelListingUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "removeChannels",
"description": "List of channels from which the product should be unassigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updateChannels",
"description": "List of channels to which the product should be assigned or updated.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductChannelListingAddInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductCreate",
"description": "Creates a new product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "category",
"description": "ID of the product's category.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeTaxes",
"description": "Determine if taxes are being charged for the product. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "List of IDs of collections that the product belongs to.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Product description.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the product metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Product name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the product private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productType",
"description": "ID of the type that product belongs to.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rating",
"description": "Defines the product rating value.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Product slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "ID of a tax class to assign to this product. If not provided, product will use the tax class which is assigned to the product type.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCode",
"description": "Tax rate for enabled tax gateway. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the Product.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductCreated",
"description": "Event sent when new product is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "category",
"description": "The category of the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "The product the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductDelete",
"description": "Deletes a product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductDeleted",
"description": "Event sent when product is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "category",
"description": "The category of the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "The product the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_ALREADY_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_CANNOT_BE_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VARIANTS_DISABLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_PRICE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MEDIA_ALREADY_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_PRODUCTS_IMAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_PRODUCTS_VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PREORDER_VARIANT_CANNOT_BE_DEACTIVATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_NOT_ASSIGNED_TO_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_WITHOUT_CATEGORY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNSUPPORTED_MEDIA_PROVIDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_NO_DIGITAL_CONTENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductFieldEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CATEGORY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE_TAXES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTIONS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DESCRIPTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_TYPE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_WEIGHT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_MEDIA",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_SKU",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_WEIGHT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableFrom",
"description": "Filter by the date of availability for purchase. \n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categories",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Specifies the channel by which the data should be filtered. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "Filter on whether product is a gift card or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasCategory",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasPreorderedVariants",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isAvailable",
"description": "Filter by availability for purchase. \n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isVisibleInListing",
"description": "Filter by visibility in product listings. \n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimalPrice",
"description": "Filter by the lowest variant price after discounts.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PriceRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "PriceRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypes",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedFrom",
"description": "Filter by the publication date. \n\nAdded in Saleor 3.8.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockAvailability",
"description": "Filter by variants having specific stock status.",
"type": {
"kind": "ENUM",
"name": "StockAvailability",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductStockFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Filter by when was the most recent update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductImage",
"description": "Represents a product image.",
"fields": [
{
"name": "alt",
"description": "The alt text of the image.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the image.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortOrder",
"description": "The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL of the image.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "category",
"description": "ID of the product's category.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeTaxes",
"description": "Determine if taxes are being charged for the product. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "List of IDs of collections that the product belongs to.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Product description.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the product metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Product name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the product private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rating",
"description": "Defines the product rating value.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seo",
"description": "Search engine optimization fields.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Product slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "ID of a tax class to assign to this product. If not provided, product will use the tax class which is assigned to the product type.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCode",
"description": "Tax rate for enabled tax gateway. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the Product.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMedia",
"description": "Represents a product media.",
"fields": [
{
"name": "alt",
"description": "The alt text of the media.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The unique ID of the product media.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.12.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.12.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oembedData",
"description": "The oEmbed data of the media.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.12.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.12.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productId",
"description": "Product id the media refers to.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortOrder",
"description": "The sort order of the media.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of the media.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductMediaType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "The URL of the media.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaBulkDelete",
"description": "Deletes product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaCreate",
"description": "Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductMediaCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "alt",
"description": "Alt text for a product media.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "image",
"description": "Represents an image file in a multipart request.",
"type": {
"kind": "SCALAR",
"name": "Upload",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "mediaUrl",
"description": "Represents an URL to an external media.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "ID of an product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaCreated",
"description": "Event sent when new product media is created.\n\nAdded in Saleor 3.12.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMedia",
"description": "The product media the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaDelete",
"description": "Deletes a product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaDeleted",
"description": "Event sent when product media is deleted.\n\nAdded in Saleor 3.12.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMedia",
"description": "The product media the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaReorder",
"description": "Changes ordering of the product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": null,
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductMediaType",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "IMAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VIDEO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaUpdate",
"description": "Updates a product media. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductMediaUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "alt",
"description": "Alt text for a product media.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMediaUpdated",
"description": "Event sent when product media is updated.\n\nAdded in Saleor 3.12.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productMedia",
"description": "The product media the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductMetadataUpdated",
"description": "Event sent when product metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "category",
"description": "The category of the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "The product the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductOrder",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributeId",
"description": "Sort product by the selected attribute's values.\nNote: this doesn't take translations into account yet.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Specifies the channel in which to sort the data.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "direction",
"description": "Specifies the direction in which to sort products.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort products by the selected field.",
"type": {
"kind": "ENUM",
"name": "ProductOrderField",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductOrderField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "COLLECTION",
"description": "Sort products by collection. Note: This option is available only for the `Collection.products` query.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CREATED_AT",
"description": "Sort products by creation date.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DATE",
"description": "Sort products by update date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_MODIFIED",
"description": "Sort products by update date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_MODIFIED_AT",
"description": "Sort products by update date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MINIMAL_PRICE",
"description": "Sort products by a minimal price of a product's variant.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort products by name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRICE",
"description": "Sort products by price.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLICATION_DATE",
"description": "Sort products by publication date.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLISHED",
"description": "Sort products by publication status.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PUBLISHED_AT",
"description": "Sort products by publication date.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RANK",
"description": "Sort products by rank. Note: This option is available only with the `search` filter.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "RATING",
"description": "Sort products by rating.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TYPE",
"description": "Sort products by type.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductPricingInfo",
"description": "Represents availability of a product in the storefront.",
"fields": [
{
"name": "discount",
"description": "The discount amount if in sale (null otherwise).",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountLocalCurrency",
"description": "The discount amount in the local currency.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Always returns `null`."
},
{
"name": "displayGrossPrices",
"description": "Determines whether this product's price displayed in a storefront should include taxes.\n\nAdded in Saleor 3.9.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "onSale",
"description": "Whether it is in sale or not.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceRange",
"description": "The discounted price range of the product variants.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoneyRange",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceRangeLocalCurrency",
"description": "The discounted price range of the product variants in the local currency.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoneyRange",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Always returns `null`."
},
{
"name": "priceRangeUndiscounted",
"description": "The undiscounted price range of the product variants.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoneyRange",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductReorderAttributeValues",
"description": "Reorder product attribute values. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "Product from which attribute values are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductStockFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "quantity",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "IntRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseIds",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTranslatableContent",
"description": null,
"fields": [
{
"name": "attributeValues",
"description": "List of product attribute values that can be translated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValueTranslatableContent",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Product's description to translate.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Description of the product.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the product translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Product's name to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "Represents an individual item for sale in the storefront.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "seoDescription",
"description": "SEO description to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "SEO title to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated product fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for product.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTranslate",
"description": "Creates/updates translations for a product. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductTranslateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTranslation",
"description": null,
"fields": [
{
"name": "description",
"description": "Translated description of the product.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "descriptionJson",
"description": "Translated description of the product.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `description` field instead."
},
{
"name": "id",
"description": "The ID of the product translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated product name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": "Translated SEO description.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": "Translated SEO title.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductType",
"description": "Represents a type of product. It defines what attributes are available to products of this type.",
"fields": [
{
"name": "assignedVariantAttributes",
"description": "Variant attributes of that product type with attached variant selection.\n\nAdded in Saleor 3.1.",
"args": [
{
"name": "variantSelection",
"description": "Define scope of returned attributes.",
"type": {
"kind": "ENUM",
"name": "VariantAttributeScope",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AssignedVariantAttribute",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableAttributes",
"description": "List of attributes which can be assigned to this product type.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasVariants",
"description": "Whether the product type has variants.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the product type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isDigital",
"description": "Whether the product type is digital.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isShippingRequired",
"description": "Whether shipping is required for this product type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "kind",
"description": "The product type kind.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductTypeKindEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the product type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productAttributes",
"description": "Product attributes of that product type.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products of this type.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCountableConnection",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the top-level `products` query with the `productTypes` filter."
},
{
"name": "slug",
"description": "Slug of the product type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "Tax class assigned to this product type. All products of this product type use this tax class, unless it's overridden in the `Product` type.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxType",
"description": "A type of tax. Assigned by enabled tax gateway",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxType",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `taxClass` field instead."
},
{
"name": "variantAttributes",
"description": "Variant attributes of that product type.",
"args": [
{
"name": "variantSelection",
"description": "Define scope of returned attributes.",
"type": {
"kind": "ENUM",
"name": "VariantAttributeScope",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `assignedVariantAttributes` instead."
},
{
"name": "weight",
"description": "Weight of the product type.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTypeBulkDelete",
"description": "Deletes product types. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductTypeConfigurable",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CONFIGURABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SIMPLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTypeCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductTypeCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTypeCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTypeCreate",
"description": "Creates a new product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productType",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTypeDelete",
"description": "Deletes a product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productType",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductTypeEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DIGITAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPABLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductTypeFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "configurable",
"description": null,
"type": {
"kind": "ENUM",
"name": "ProductTypeConfigurable",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "kind",
"description": null,
"type": {
"kind": "ENUM",
"name": "ProductTypeKindEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productType",
"description": null,
"type": {
"kind": "ENUM",
"name": "ProductTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductTypeInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "hasVariants",
"description": "Determines if product of this type has multiple variants. This option mainly simplifies product management in the dashboard. There is always at least one variant created under the hood.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isDigital",
"description": "Determines if products are digital.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isShippingRequired",
"description": "Determines if shipping is required for products of this variant.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "kind",
"description": "The product type kind.",
"type": {
"kind": "ENUM",
"name": "ProductTypeKindEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the product type.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productAttributes",
"description": "List of attributes shared among all product variants.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Product type slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "ID of a tax class to assign to this product type. All products of this product type would use this tax class, unless it's overridden in the `Product` type.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCode",
"description": "Tax rate for enabled tax gateway. \n\nDEPRECATED: this field will be removed in Saleor 4.0.. Use tax classes to control the tax calculation for a product type. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantAttributes",
"description": "List of attributes used to distinguish between different variants of a product.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the ProductType items.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductTypeKindEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GIFT_CARD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NORMAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTypeReorderAttributes",
"description": "Reorder the attributes of a product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productType",
"description": "Product type from which attributes are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductTypeSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DIGITAL",
"description": "Sort products by type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort products by name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_REQUIRED",
"description": "Sort products by shipping.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductTypeSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort product types.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort product types by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductTypeSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductTypeUpdate",
"description": "Updates an existing product type. \n\nRequires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productType",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductUpdate",
"description": "Updates an existing product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductUpdated",
"description": "Event sent when product is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "category",
"description": "The category of the product.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "The product the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"description": "Represents a version of a product such as different size or color.",
"fields": [
{
"name": "attributes",
"description": "List of attributes assigned to this variant.",
"args": [
{
"name": "variantSelection",
"description": "Define scope of returned attributes.",
"type": {
"kind": "ENUM",
"name": "VariantAttributeScope",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SelectedAttribute",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Channel given to retrieve this product variant. Also used by federation gateway to resolve this object in a federated query.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of price information in channels for the product.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantChannelListing",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": "The date and time when the product variant was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContent",
"description": "Digital content for the product variant.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product. \n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the product variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "images",
"description": "List of images for the product variant.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductImage",
"ofType": null
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `media` field instead."
},
{
"name": "margin",
"description": "Gross margin percentage value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": "List of media for the product variant.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the product variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorder",
"description": "Preorder data for product variant.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PreorderData",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pricing",
"description": "Lists the storefront variant's pricing, the current price and discounts, only meant for displaying.",
"args": [
{
"name": "address",
"description": "Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VariantPricingInfo",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "The product to which the variant belongs.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityAvailable",
"description": "Quantity of a product available for sale in one checkout. Field value will be `null` when no `limitQuantityPerCheckout` in global settings has been set, and `productVariant` stocks are not tracked.",
"args": [
{
"name": "address",
"description": "Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "Two-letter ISO 3166-1 country code. When provided, the exact quantity from a warehouse operating in shipping zones that contain this country will be returned. Otherwise, it will return the maximum quantity from all shipping zones. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `address` argument instead.",
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityLimitPerCustomer",
"description": "The maximum quantity of this variant that a customer can purchase.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityOrdered",
"description": "Total quantity ordered.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "revenue",
"description": "Total revenue generated by a variant in given period of time. Note: this field should be queried using `reportProductSales` query as it uses optimizations suitable for such calculations.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "period",
"description": null,
"type": {
"kind": "ENUM",
"name": "ReportingPeriod",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "The SKU (stock keeping unit) of the product variant.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "Stocks for the product variant.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.",
"args": [
{
"name": "address",
"description": "Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "Two-letter ISO 3166-1 country code. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `address` argument instead.",
"type": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Stock",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackInventory",
"description": "Whether the inventory of the variant is tracked.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated product variant fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The date and time when the product variant was last updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "The weight of the product variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBackInStock",
"description": "Event sent when product variant is back in stock.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "The product variant the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "Look up a warehouse.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkCreate",
"description": "Creates product variants for a given product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "bulkProductErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "count",
"description": "Returns how many objects were created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariants",
"description": "List of the created variants.This field will be removed in Saleor 4.0.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the created variants.\n\nAdded in Saleor 3.11.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantBulkResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantBulkCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes specific to this variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "BulkAttributeValueInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of prices assigned to channels.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantChannelListingAddInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product variant.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the product variant metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Variant name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorder",
"description": "Determines if variant is in preorder.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PreorderSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the product variant private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityLimitPerCustomer",
"description": "Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "Stock keeping unit.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "Stocks of a product available for sale.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StockInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackInventory",
"description": "Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the Product Variant.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkDelete",
"description": "Deletes product variants. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkError",
"description": null,
"fields": [
{
"name": "attributes",
"description": "List of attributes IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of channel listings IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": "List of channel IDs which causes the error.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductVariantBulkErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.\n\nAdded in Saleor 3.14.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "List of stocks IDs which causes the error.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "List of attribute values IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouse IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductVariantBulkErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ATTRIBUTE_ALREADY_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_CANNOT_BE_ASSIGNED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VARIANTS_DISABLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_PRICE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_PRODUCTS_VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_NOT_ASSIGNED_TO_CHANNEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on create attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantBulkError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Product variant data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkTranslate",
"description": "Creates/updates translations for products variants.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.\n\nTriggers the following webhook events:\n- TRANSLATION_CREATED (async): A translation was created.\n- TRANSLATION_UPDATED (async): A translation was updated.",
"fields": [
{
"name": "count",
"description": "Returns how many translations were created/updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantBulkTranslateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the translations.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantBulkTranslateResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkTranslateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductVariantTranslateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "path",
"description": "Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantBulkTranslateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "externalReference",
"description": "External reference of a product variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Product variant ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "Translation language code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationFields",
"description": "Translation fields.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "NameTranslationInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkTranslateResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on translation attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantBulkTranslateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Product variant translation data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariantTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantBulkUpdate",
"description": "Update multiple product variants.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantBulkError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the updated variants.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantBulkResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantBulkUpdateInput",
"description": "Input fields to update product variants.\n\nAdded in Saleor 3.11.",
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes specific to this variant.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "BulkAttributeValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "Channel listings input.\n\nAdded in Saleor 3.12.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantChannelListingUpdateInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product variant.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the product variant to update.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the product variant metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Variant name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorder",
"description": "Determines if variant is in preorder.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PreorderSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the product variant private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityLimitPerCustomer",
"description": "Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "Stock keeping unit.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "Stocks input.\n\nAdded in Saleor 3.12.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantStocksUpdateInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackInventory",
"description": "Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the Product Variant.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantChannelListing",
"description": "Represents product variant channel listing.",
"fields": [
{
"name": "channel",
"description": "The channel to which the variant listing belongs.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "costPrice",
"description": "Cost price of the variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the variant channel listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "margin",
"description": "Gross margin percentage value.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorderThreshold",
"description": "Preorder variant data.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "PreorderThreshold",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The price of the variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantChannelListingAddInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "costPrice",
"description": "Cost price of the variant in channel.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorderThreshold",
"description": "The threshold for preorder variant in channel.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Price of the particular variant in channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantChannelListingUpdate",
"description": "Manage product variant prices in channels. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductChannelListingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productChannelListingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductChannelListingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "variant",
"description": "An updated product variant instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantChannelListingUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "create",
"description": "List of channels to create variant channel listings.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantChannelListingAddInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "remove",
"description": "List of channel listings to remove.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "update",
"description": "List of channel listings to update.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ChannelListingUpdateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariantCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantCreate",
"description": "Creates a new variant for a product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productVariant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes specific to this variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product variant.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the product variant metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Variant name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorder",
"description": "Determines if variant is in preorder.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PreorderSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the product variant private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "Product ID of which type is the variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityLimitPerCustomer",
"description": "Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "Stock keeping unit.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "Stocks of a product available for sale.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StockInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackInventory",
"description": "Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the Product Variant.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantCreated",
"description": "Event sent when new product variant is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "The product variant the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantDelete",
"description": "Deletes a product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productVariant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantDeleted",
"description": "Event sent when product variant is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "The product variant the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "isPreorder",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "attributes",
"description": "List of attributes specific to this variant.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeValueInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this product variant.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the product variant metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Variant name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "preorder",
"description": "Determines if variant is in preorder.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PreorderSettingsInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the product variant private metadata.\n\nAdded in Saleor 3.8.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityLimitPerCustomer",
"description": "Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "Stock keeping unit.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackInventory",
"description": "Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "weight",
"description": "Weight of the Product Variant.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantMetadataUpdated",
"description": "Event sent when product variant metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "The product variant the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantOutOfStock",
"description": "Event sent when product variant is out of stock.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "The product variant the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "Look up a warehouse.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantPreorderDeactivate",
"description": "Deactivates product variant preorder. It changes all preorder allocation into regular allocation.\n\nAdded in Saleor 3.1. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Product variant with ended preorder.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantReorder",
"description": "Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantReorderAttributeValues",
"description": "Reorder product variant attribute values. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productVariant",
"description": "Product variant from which attribute values are reordered.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantSetDefault",
"description": "Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductVariantSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "LAST_MODIFIED_AT",
"description": "Sort products variants by last modified at.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort productVariants.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort productVariants by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ProductVariantSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantStockUpdated",
"description": "Event sent when product variant stock is updated.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "The product variant the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "Look up a warehouse.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantStocksCreate",
"description": "Creates stocks for product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "bulkStockErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkStockError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkStockError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Updated product variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantStocksDelete",
"description": "Delete stocks from product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StockError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Updated product variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StockError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantStocksUpdate",
"description": "Update stocks for product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "bulkStockErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkStockError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "BulkStockError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Updated product variant.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantStocksUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "create",
"description": "List of warehouses to create stocks.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StockInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "remove",
"description": "List of stocks to remove.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "update",
"description": "List of stocks to update.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "StockUpdateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantTranslatableContent",
"description": null,
"fields": [
{
"name": "attributeValues",
"description": "List of product variant attribute values that can be translated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValueTranslatableContent",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the product variant translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the product variant to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Represents a version of a product such as different size or color.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "translation",
"description": "Returns translated product variant fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for product variant.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantTranslate",
"description": "Creates/updates translations for a product variant. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ProductVariantTranslateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantTranslation",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the product variant translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated product variant name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantUpdate",
"description": "Updates an existing variant for product. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productVariant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ProductVariantUpdated",
"description": "Event sent when product variant is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "The product variant the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductVariantWhereInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "AND",
"description": "List of conditions that must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OR",
"description": "A list of conditions of which at least one must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ProductWhereInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "AND",
"description": "List of conditions that must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OR",
"description": "A list of conditions of which at least one must be met.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ProductWhereInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributes",
"description": "Filter by attributes associated with the product.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AttributeInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableFrom",
"description": "Filter by the date of availability for purchase.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "category",
"description": "Filter by product category.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GlobalIDFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collection",
"description": "Filter by collection.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GlobalIDFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "Filter on whether product is a gift card or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasCategory",
"description": "Filter by product with category assigned.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "hasPreorderedVariants",
"description": "Filter by product with preordered variants.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isAvailable",
"description": "Filter by availability for purchase.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Filter by public visibility.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isVisibleInListing",
"description": "Filter by visibility on the channel.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimalPrice",
"description": "Filter by the lowest variant price after discounts.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DecimalFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Filter by product name.",
"type": {
"kind": "INPUT_OBJECT",
"name": "StringFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Filter by product variant price.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DecimalFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productType",
"description": "Filter by product type.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GlobalIDFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedFrom",
"description": "Filter by the publication date.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Filter by product slug.",
"type": {
"kind": "INPUT_OBJECT",
"name": "StringFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stockAvailability",
"description": "Filter by variants having specific stock status.",
"type": {
"kind": "ENUM",
"name": "StockAvailability",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "Filter by stock of the product variant.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductStockFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "Filter by when was the most recent update.",
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "PublishableChannelListingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPublished",
"description": "Determines if object is visible to customers.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publicationDate",
"description": "Publication date. ISO 8601 standard. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.",
"type": {
"kind": "SCALAR",
"name": "Date",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "publishedAt",
"description": "Publication date time. ISO 8601 standard.\n\nAdded in Saleor 3.3.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Query",
"description": null,
"fields": [
{
"name": "_entities",
"description": null,
"args": [
{
"name": "representations",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "_Any",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "UNION",
"name": "_Entity",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "_service",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "_Service",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "address",
"description": "Look up an address by ID.\n\nRequires one of the following permissions: MANAGE_USERS, OWNER.",
"args": [
{
"name": "id",
"description": "ID of an address.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addressValidationRules",
"description": "Returns address validation rules.",
"args": [
{
"name": "city",
"description": "City or a town name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cityArea",
"description": "Sublocality like a district.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryArea",
"description": "Designation of a region, province or state.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "Two-letter ISO 3166-1 country code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AddressValidationData",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "app",
"description": "Look up an app by ID. If ID is not provided, return the currently authenticated app.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER AUTHENTICATED_APP. The authenticated app has access to its resources. Fetching different apps requires MANAGE_APPS permission.",
"args": [
{
"name": "id",
"description": "ID of the app.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appExtension",
"description": "Look up an app extension by ID.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [
{
"name": "id",
"description": "ID of the app extension.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppExtension",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appExtensions",
"description": "List of all extensions.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for apps extensions.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AppExtensionFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppExtensionCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "apps",
"description": "List of the apps.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, MANAGE_APPS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for apps.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AppFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort apps.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AppSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AppCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "appsInstallations",
"description": "List of all apps installations\n\nRequires one of the following permissions: MANAGE_APPS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AppInstallation",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attribute",
"description": "Look up an attribute by ID, slug or external reference.",
"args": [
{
"name": "externalReference",
"description": "External ID of the attribute. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the attribute.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the attribute.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "attributes",
"description": "List of the shop's attributes.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for attributes.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": "Search attributes.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sorting options for attributes.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": "Filtering options for attributes.\n\nAdded in Saleor 3.11.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AttributeWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "AttributeCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categories",
"description": "List of the shop's categories.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for categories.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CategoryFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "level",
"description": "Filter categories by the nesting level in the category tree.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort categories.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CategorySortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": "Where filtering options.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CategoryWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "category",
"description": "Look up a category by ID or slug.",
"args": [
{
"name": "id",
"description": "ID of the category.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the category",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Look up a channel by ID or slug.",
"args": [
{
"name": "id",
"description": "ID of the channel.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the channel.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channels",
"description": "List of all channels.\n\nRequires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkout",
"description": "Look up a checkout by id.\n\nRequires one of the following permissions to query checkouts that belong to other users: MANAGE_CHECKOUTS, IMPERSONATE_USER. ",
"args": [
{
"name": "id",
"description": "The checkout's ID.\n\nAdded in Saleor 3.4.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "The checkout's token.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.",
"type": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutLines",
"description": "List of checkout lines.\n\nRequires one of the following permissions: MANAGE_CHECKOUTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutLineCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkouts",
"description": "List of checkouts.\n\nRequires one of the following permissions: MANAGE_CHECKOUTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for checkouts.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CheckoutFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort checkouts.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CheckoutSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collection",
"description": "Look up a collection by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the collection.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the category",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "List of the shop's collections. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for collections.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CollectionFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort collections.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CollectionSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": "Where filtering options.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CollectionWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customers",
"description": "List of the shop's customers.\n\nRequires one of the following permissions: MANAGE_ORDERS, MANAGE_USERS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for customers.",
"type": {
"kind": "INPUT_OBJECT",
"name": "CustomerFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort customers.",
"type": {
"kind": "INPUT_OBJECT",
"name": "UserSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "UserCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContent",
"description": "Look up digital content by ID.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of the digital content.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DigitalContent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "digitalContents",
"description": "List of digital content.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "DigitalContentCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "draftOrders",
"description": "List of draft orders.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for draft orders.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderDraftFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort draft orders.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "exportFile",
"description": "Look up a export file by ID.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of the export file job.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExportFile",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "exportFiles",
"description": "List of export files.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for export files.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ExportFileFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort export files.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ExportFileSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ExportFileCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCard",
"description": "Look up a gift card by ID.\n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [
{
"name": "id",
"description": "ID of the gift card.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCard",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardCurrencies",
"description": "List of gift card currencies.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardSettings",
"description": "Gift card related settings from site settings.\n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "GiftCardSettings",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCardTags",
"description": "List of gift card tags.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for gift card tags.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GiftCardTagFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardTagCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCards",
"description": "List of gift cards.\n\nRequires one of the following permissions: MANAGE_GIFT_CARD.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for gift cards.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GiftCardFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": "Search gift cards by email and name of user, who created or used the gift card, and by code.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort gift cards.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "INPUT_OBJECT",
"name": "GiftCardSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "homepageEvents",
"description": "List of activity events to display on homepage (at the moment it only contains order-events).\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderEventCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "me",
"description": "Return the currently authenticated user.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menu",
"description": "Look up a navigation menu by ID or name.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the menu.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The menu's name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "The menu's slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Menu",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItem",
"description": "Look up a menu item by ID.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the menu item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menuItems",
"description": "List of the storefronts's menu items.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for menu items.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MenuItemFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort menus items.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MenuItemSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuItemCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "menus",
"description": "List of the storefront's menus.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for menus. \n\n`slug`: This field will be removed in Saleor 4.0. Use `slugs` instead.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MenuFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort menus.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MenuSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "MenuCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "Look up an order by ID or external reference.",
"args": [
{
"name": "externalReference",
"description": "External ID of an order. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of an order.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orderByToken",
"description": "Look up an order by token.",
"args": [
{
"name": "token",
"description": "The order's token.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "orderSettings",
"description": "Order related settings from site settings. Returns `orderSettings` for the first `channel` in alphabetical order.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderSettings",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `channel` query to fetch the `orderSettings` field instead."
},
{
"name": "orders",
"description": "List of orders.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for orders.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort orders.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ordersTotal",
"description": "Return the total sales amount from a specific period.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "period",
"description": "A period of time.",
"type": {
"kind": "ENUM",
"name": "ReportingPeriod",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "page",
"description": "Look up a page by ID or slug.",
"args": [
{
"name": "id",
"description": "ID of the page.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "The slug of the page.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Page",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageType",
"description": "Look up a page type by ID.",
"args": [
{
"name": "id",
"description": "ID of the page type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageTypes",
"description": "List of the page types.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for page types.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PageTypeFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort page types.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PageTypeSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageTypeCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pages",
"description": "List of the shop's pages.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for pages.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PageFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort pages.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PageSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PageCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": "Look up a payment by ID.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "id",
"description": "ID of the payment.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payments",
"description": "List of payments.\n\nRequires one of the following permissions: MANAGE_ORDERS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for payments.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PaymentFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PaymentCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroup",
"description": "Look up permission group by ID.\n\nRequires one of the following permissions: MANAGE_STAFF.",
"args": [
{
"name": "id",
"description": "ID of the group.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroups",
"description": "List of permission groups.\n\nRequires one of the following permissions: MANAGE_STAFF.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for permission groups.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PermissionGroupFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort permission groups.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PermissionGroupSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GroupCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plugin",
"description": "Look up a plugin by ID.\n\nRequires one of the following permissions: MANAGE_PLUGINS.",
"args": [
{
"name": "id",
"description": "ID of the plugin.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Plugin",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "plugins",
"description": "List of plugins.\n\nRequires one of the following permissions: MANAGE_PLUGINS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for plugins.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PluginFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort plugins.",
"type": {
"kind": "INPUT_OBJECT",
"name": "PluginSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "PluginCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "product",
"description": "Look up a product by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the product. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the product.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Slug of the product.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productType",
"description": "Look up a product type by ID.",
"args": [
{
"name": "id",
"description": "ID of the product type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productTypes",
"description": "List of the shop's product types.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for product types.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductTypeFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort product types.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductTypeSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductTypeCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Look up a product variant by ID or SKU. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the product. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the product variant.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sku",
"description": "SKU of the product variant.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariants",
"description": "List of product variants. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for product variant.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": "Filter product variants by given IDs.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort products variants.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": "Where filtering options.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductVariantWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of the shop's products. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for products.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": "Search products.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort products.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductOrder",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "where",
"description": "Where filtering options.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ProductWhereInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reportProductSales",
"description": "List of top selling products.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "period",
"description": "Span of time.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ReportingPeriod",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "Look up a sale by ID.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sales",
"description": "List of the shop's sales.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for sales.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SaleFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "Search sales by name, value or type. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `filter.search` input instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort sales.",
"type": {
"kind": "INPUT_OBJECT",
"name": "SaleSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "Look up a shipping zone by ID.\n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the shipping zone.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZones",
"description": "List of the shop's shipping zones.\n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for shipping zones.",
"type": {
"kind": "INPUT_OBJECT",
"name": "ShippingZoneFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZoneCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Return information about the shop.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffUsers",
"description": "List of the shop's staff users.\n\nRequires one of the following permissions: MANAGE_STAFF.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for staff users.",
"type": {
"kind": "INPUT_OBJECT",
"name": "StaffUserInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort staff users.",
"type": {
"kind": "INPUT_OBJECT",
"name": "UserSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "UserCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stock",
"description": "Look up a stock by ID\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "id",
"description": "ID of an warehouse",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Stock",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stocks",
"description": "List of stocks.\n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "StockFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "StockCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "Look up a tax class.\n\nAdded in Saleor 3.9.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [
{
"name": "id",
"description": "ID of a tax class.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClasses",
"description": "List of tax classes.\n\nAdded in Saleor 3.9.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for tax classes.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TaxClassFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort tax classes.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TaxClassSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxClassCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxConfiguration",
"description": "Look up a tax configuration.\n\nAdded in Saleor 3.9.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [
{
"name": "id",
"description": "ID of a tax configuration.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxConfiguration",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxConfigurations",
"description": "List of tax configurations.\n\nAdded in Saleor 3.9.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for tax configurations.",
"type": {
"kind": "INPUT_OBJECT",
"name": "TaxConfigurationFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxConfigurationCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCountryConfiguration",
"description": "Tax class rates grouped by country.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [
{
"name": "countryCode",
"description": "Country for which to return tax class rates.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TaxCountryConfiguration",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCountryConfigurations",
"description": "\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxCountryConfiguration",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxTypes",
"description": "List of all tax rates available from tax gateway.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxType",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Look up a transaction by ID.\n\nAdded in Saleor 3.6.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires one of the following permissions: HANDLE_PAYMENTS.",
"args": [
{
"name": "id",
"description": "ID of a transaction.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Lookup a translatable item by ID.\n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "id",
"description": "ID of the object to retrieve.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "kind",
"description": "Kind of the object to retrieve.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TranslatableKinds",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "UNION",
"name": "TranslatableItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translations",
"description": "Returns a list of all translatable items of a given kind.\n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "kind",
"description": "Kind of objects to retrieve.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TranslatableKinds",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "TranslatableItemConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "Look up a user by ID or email address.\n\nRequires one of the following permissions: MANAGE_STAFF, MANAGE_USERS, MANAGE_ORDERS.",
"args": [
{
"name": "email",
"description": "Email address of the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the user. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the user.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "Look up a voucher by ID.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "vouchers",
"description": "List of the shop's vouchers.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Filtering options for vouchers.",
"type": {
"kind": "INPUT_OBJECT",
"name": "VoucherFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "Search vouchers by name or code. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `filter.search` input instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Sort voucher.",
"type": {
"kind": "INPUT_OBJECT",
"name": "VoucherSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "Look up a warehouse by ID.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS, MANAGE_SHIPPING.",
"args": [
{
"name": "externalReference",
"description": "External ID of a warehouse. \n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of a warehouse.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouses.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS, MANAGE_SHIPPING.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "WarehouseFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "WarehouseSortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "WarehouseCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhook",
"description": "Look up a webhook by ID. Requires one of the following permissions: MANAGE_APPS, OWNER.",
"args": [
{
"name": "id",
"description": "ID of the webhook.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Webhook",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookEvents",
"description": "List of all available webhook events.\n\nRequires one of the following permissions: MANAGE_APPS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookEvent",
"ofType": null
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types."
},
{
"name": "webhookSamplePayload",
"description": "Retrieve a sample payload for a given webhook event based on real data. It can be useful for some integrations where sample payload is required.",
"args": [
{
"name": "eventType",
"description": "Name of the requested event type.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookSampleEventTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ReducedRate",
"description": "Represents a reduced VAT rate for a particular type of goods.",
"fields": [
{
"name": "rate",
"description": "Reduced VAT rate in percent.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rateType",
"description": "A type of goods.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "RefreshToken",
"description": "Refresh JWT token. Mutation tries to take refreshToken from the input. If it fails it will try to take `refreshToken` from the http-only cookie `refreshToken`. `csrfToken` is required when `refreshToken` is provided as a cookie.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "JWT token, required to authenticate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ReorderInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "id",
"description": "The ID of the item to move.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortOrder",
"description": "The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ReportingPeriod",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "THIS_MONTH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TODAY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "RequestEmailChange",
"description": "Request email change of the logged in user. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for account email change.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "RequestPasswordReset",
"description": "Sends an email with the account password modification link.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for password reset.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Sale",
"description": "Sales allow creating discounts for categories, collections or products and are visible to all the customers.",
"fields": [
{
"name": "categories",
"description": "List of categories this sale applies to.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of channels available for the sale.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SaleChannelListing",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "List of collections this sale applies to.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": "The date and time when the sale was created.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency code for sale.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValue",
"description": "Sale value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endDate",
"description": "The end date and time of the sale.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products this sale applies to.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startDate",
"description": "The start date and time of the sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated sale fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Type of the sale, fixed or percentage.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "SaleType",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The date and time when the sale was updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "List of product variants this sale applies to.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleAddCatalogues",
"description": "Adds products, categories, collections to a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_UPDATED (async): A sale was updated.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "Sale of which catalogue IDs will be modified.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleBulkDelete",
"description": "Deletes sales. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_DELETED (async): A sale was deleted.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleChannelListing",
"description": "Represents sale channel listing.",
"fields": [
{
"name": "channel",
"description": "The channel in which the sale is available.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "The currency in which the discount value is specified.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValue",
"description": "The value of the discount applied to the sale in the channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the channel listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "SaleChannelListingAddInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValue",
"description": "The value of the discount.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "SaleChannelListingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to which the sale should be assigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "SaleChannelListingAddInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeChannels",
"description": "List of channels from which the sale should be unassigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleChannelListingUpdate",
"description": "Manage sale's availability in channels. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "An updated sale instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SaleCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleCreate",
"description": "Creates a new sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_CREATED (async): A sale was created.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleCreated",
"description": "Event sent when new sale is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "The sale the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleDelete",
"description": "Deletes a sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_DELETED (async): A sale was deleted.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleDeleted",
"description": "Event sent when sale is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "The sale the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "SaleFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "saleType",
"description": null,
"type": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "started",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountStatusEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "SaleInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "categories",
"description": "Categories related to the discount.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "Collections related to the discount.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endDate",
"description": "End date of the voucher in ISO 8601 format.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Voucher name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "Products related to the discount.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startDate",
"description": "Start date of the voucher in ISO 8601 format.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Fixed or percentage.",
"type": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Value of the voucher.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleRemoveCatalogues",
"description": "Removes products, categories, collections from a sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_UPDATED (async): A sale was updated.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "Sale of which catalogue IDs will be modified.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "SaleSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort sales by created at.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "END_DATE",
"description": "Sort sales by end date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_MODIFIED_AT",
"description": "Sort sales by last modified at.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NAME",
"description": "Sort sales by name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "START_DATE",
"description": "Sort sales by start date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TYPE",
"description": "Sort sales by type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VALUE",
"description": "Sort sales by value.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "SaleSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Specifies the channel in which to sort the data.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "direction",
"description": "Specifies the direction in which to sort sales.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort sales by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "SaleSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleToggle",
"description": "The event informs about the start or end of the sale.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "The sale the event relates to.\n\nAdded in Saleor 3.5.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleTranslatableContent",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the sale translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the sale to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "Sales allow creating discounts for categories, collections or products and are visible to all the customers.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "translation",
"description": "Returns translated sale fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for sale.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "SaleTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleTranslate",
"description": "Creates/updates translations for a sale. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleTranslation",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the sale translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated name of sale.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "SaleType",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FIXED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERCENTAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleUpdate",
"description": "Updates a sale. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- SALE_UPDATED (async): A sale was updated.\n- SALE_TOGGLE (async): Optionally triggered when a sale is started or stopped.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SaleUpdated",
"description": "Event sent when sale is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sale",
"description": "The sale the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Sale",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SelectedAttribute",
"description": "Represents a custom attribute.",
"fields": [
{
"name": "attribute",
"description": "Name of an attribute displayed in the interface.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Attribute",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "values",
"description": "Values of an attribute.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AttributeValue",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SendConfirmationEmail",
"description": "Sends a notification confirmation.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: AUTHENTICATED_USER.\n\nTriggers the following webhook events:\n- NOTIFY_USER (async): A notification for account confirmation.\n- ACCOUNT_CONFIRMATION_REQUESTED (async): An account confirmation was requested. This event is always sent regardless of settings.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "SendConfirmationEmailError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SendConfirmationEmailError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "SendConfirmationEmailErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "SendConfirmationEmailErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCOUNT_CONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONFIRMATION_ALREADY_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_CHANNEL_SLUG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "SeoInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "description",
"description": "SEO description.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "title",
"description": "SEO title.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "SetPassword",
"description": "Sets the user's password from the token sent by email using the RequestPasswordReset mutation.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "csrfToken",
"description": "CSRF token required to re-generate access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refreshToken",
"description": "JWT refresh token, required to re-generate access token.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": "JWT token, required to authenticate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "A user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingError",
"description": null,
"fields": [
{
"name": "channels",
"description": "List of channels IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ShippingErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouse IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ShippingErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MAX_LESS_THAN_MIN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingListMethodsForCheckout",
"description": "List shipping methods for checkout.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "checkout",
"description": "The checkout the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethods",
"description": "Shipping methods that can be used with this checkout.\n\nAdded in Saleor 3.6.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethod",
"description": "Shipping methods that can be used as means of shipping for orders and checkouts.",
"fields": [
{
"name": "active",
"description": "Describes if this shipping method is active and can be selected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Shipping method description.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Unique ID of ShippingMethod available for Order.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumDeliveryDays",
"description": "Maximum delivery days for this shipping method.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumOrderPrice",
"description": "Maximum order price for this shipping method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumOrderWeight",
"description": "Maximum order weight for this shipping method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "message",
"description": "Message connected to this shipping method.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumDeliveryDays",
"description": "Minimum delivery days for this shipping method.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumOrderPrice",
"description": "Minimal order price for this shipping method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumOrderWeight",
"description": "Minimum order weight for this shipping method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
},
{
"name": "name",
"description": "Shipping method name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The price of selected shipping method.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated shipping method fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for shipping method.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Type of the shipping method.",
"args": [],
"type": {
"kind": "ENUM",
"name": "ShippingMethodTypeEnum",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0."
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodChannelListing",
"description": "Represents shipping method channel listing.",
"fields": [
{
"name": "channel",
"description": "The channel associated with the shipping method channel listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of shipping method channel listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumOrderPrice",
"description": "Maximum order price.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumOrderPrice",
"description": "Minimum order price.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Price of the shipping method in the associated channel.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingMethodChannelListingAddInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumOrderPrice",
"description": "Maximum order price to use this shipping method.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumOrderPrice",
"description": "Minimum order price to use this shipping method.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "Shipping price of the shipping method in this channel.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingMethodChannelListingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to which the shipping method should be assigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingMethodChannelListingAddInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeChannels",
"description": "List of channels from which the shipping method should be unassigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodChannelListingUpdate",
"description": "Manage shipping method's availability in channels. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingMethod",
"description": "An updated shipping method instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodPostalCodeRule",
"description": "Represents shipping method postal code rule.",
"fields": [
{
"name": "end",
"description": "End address range.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inclusionType",
"description": "Inclusion type of the postal code rule.",
"args": [],
"type": {
"kind": "ENUM",
"name": "PostalCodeRuleInclusionTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "start",
"description": "Start address range.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodTranslatableContent",
"description": null,
"fields": [
{
"name": "description",
"description": "Shipping method description to translate.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the shipping method translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Shipping method name to translate.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.\n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
},
{
"name": "translation",
"description": "Returns translated shipping method fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for shipping method.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodTranslation",
"description": null,
"fields": [
{
"name": "description",
"description": "Translated description of the shipping method.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the shipping method translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated shipping method name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodType",
"description": "Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.",
"fields": [
{
"name": "channelListings",
"description": "List of channels available for the method.\n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethodChannelListing",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Shipping method description.\n\nRich text format. For reference see https://editorjs.io/",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "excludedProducts",
"description": "List of excluded products for the shipping method.\n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "Shipping method ID.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumDeliveryDays",
"description": "Maximum number of days for delivery.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumOrderPrice",
"description": "The price of the cheapest variant (including discounts).",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumOrderWeight",
"description": "Maximum order weight to use this shipping method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumDeliveryDays",
"description": "Minimal number of days for delivery.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumOrderPrice",
"description": "The price of the cheapest variant (including discounts).",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumOrderWeight",
"description": "Minimum order weight to use this shipping method.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Weight",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Shipping method name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "postalCodeRules",
"description": "Postal code ranges rule of exclusion or inclusion of the shipping method.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethodPostalCodeRule",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "Tax class assigned to this shipping method.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated shipping method fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for shipping method.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Type of the shipping method.",
"args": [],
"type": {
"kind": "ENUM",
"name": "ShippingMethodTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ShippingMethodTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "PRICE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WEIGHT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodsPerCountry",
"description": "List of shipping methods available for the country.\n\nAdded in Saleor 3.6.",
"fields": [
{
"name": "countryCode",
"description": "The country code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethods",
"description": "List of available shipping methods.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingPostalCodeRulesCreateInputRange",
"description": null,
"fields": null,
"inputFields": [
{
"name": "end",
"description": "End range of the postal code.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "start",
"description": "Start range of the postal code.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceBulkDelete",
"description": "Deletes shipping prices. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceCreate",
"description": "Creates a new shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingMethod",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "A shipping zone to which the shipping method belongs.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceCreated",
"description": "Event sent when new shipping price is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "The shipping method the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "The shipping zone the shipping method belongs to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceDelete",
"description": "Deletes a shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingMethod",
"description": "A shipping method to delete.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "A shipping zone to which the shipping method belongs.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceDeleted",
"description": "Event sent when shipping price is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "The shipping method the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "The shipping zone the shipping method belongs to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceExcludeProducts",
"description": "Exclude products from shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingMethod",
"description": "A shipping method with new list of excluded products.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingPriceExcludeProductsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "products",
"description": "List of products which will be excluded.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingPriceInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addPostalCodeRules",
"description": "Postal code rules to add.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "ShippingPostalCodeRulesCreateInputRange",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deletePostalCodeRules",
"description": "Postal code rules to delete.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Shipping method description.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inclusionType",
"description": "Inclusion type for currently assigned postal code rules.",
"type": {
"kind": "ENUM",
"name": "PostalCodeRuleInclusionTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumDeliveryDays",
"description": "Maximum number of days for delivery.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "maximumOrderWeight",
"description": "Maximum order weight to use this shipping method.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumDeliveryDays",
"description": "Minimal number of days for delivery.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minimumOrderWeight",
"description": "Minimum order weight to use this shipping method.",
"type": {
"kind": "SCALAR",
"name": "WeightScalar",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the shipping method.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "Shipping zone this method belongs to.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "ID of a tax class to assign to this shipping method. If not provided, the default tax class will be used.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Shipping type: price or weight based.",
"type": {
"kind": "ENUM",
"name": "ShippingMethodTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceRemoveProductFromExclude",
"description": "Remove product from excluded list for shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingMethod",
"description": "A shipping method with new list of excluded products.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceTranslate",
"description": "Creates/updates translations for a shipping method. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingPriceTranslationInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "description",
"description": "Translated shipping method description.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceUpdate",
"description": "Updates a new shipping price. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingMethod",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "A shipping zone to which the shipping method belongs.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingPriceUpdated",
"description": "Event sent when shipping price is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethod",
"description": "The shipping method the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "The shipping zone the shipping method belongs to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZone",
"description": "Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly.",
"fields": [
{
"name": "channels",
"description": "List of channels for shipping zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "List of countries available for the method.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "default",
"description": "Indicates if the shipping zone is default one.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of a shipping zone.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of shipping zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Shipping zone name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceRange",
"description": "Lowest and highest prices for the shipping.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "MoneyRange",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingMethods",
"description": "List of shipping methods available for orders shipped to countries within this shipping zone.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethodType",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouses",
"description": "List of warehouses for shipping zone.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneBulkDelete",
"description": "Deletes shipping zones. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingZoneCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneCreate",
"description": "Creates a new shipping zone. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingZone",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingZoneCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to assign to the shipping zone.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addWarehouses",
"description": "List of warehouses to assign to a shipping zone",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "List of countries in this shipping zone.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "default",
"description": "Default shipping zone will be used for countries not covered by other zones.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the shipping zone.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Shipping zone's name. Visible only to the staff.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneCreated",
"description": "Event sent when new shipping zone is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "The shipping zone the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneDelete",
"description": "Deletes a shipping zone. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingZone",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneDeleted",
"description": "Event sent when shipping zone is deleted.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "The shipping zone the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingZoneFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channels",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneMetadataUpdated",
"description": "Event sent when shipping zone metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "The shipping zone the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneUpdate",
"description": "Updates a new shipping zone. \n\nRequires one of the following permissions: MANAGE_SHIPPING.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "shippingZone",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShippingZoneUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to assign to the shipping zone.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addWarehouses",
"description": "List of warehouses to assign to a shipping zone",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "List of countries in this shipping zone.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "default",
"description": "Default shipping zone will be used for countries not covered by other zones.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Description of the shipping zone.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Shipping zone's name. Visible only to the staff.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeChannels",
"description": "List of channels to unassign from the shipping zone.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeWarehouses",
"description": "List of warehouses to unassign from a shipping zone",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShippingZoneUpdated",
"description": "Event sent when shipping zone is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZone",
"description": "The shipping zone the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShippingZone",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Shop",
"description": "Represents a shop resource containing general shop data and configuration.",
"fields": [
{
"name": "allowLoginWithoutConfirmation",
"description": "Determines if user can login without confirmation when `enableAccountConfrimation` is enabled.\n\nAdded in Saleor 3.15.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticFulfillmentDigitalProducts",
"description": "Enable automatic fulfillment for all digital products.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableExternalAuthentications",
"description": "List of available external authentications.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ExternalAuthentication",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availablePaymentGateways",
"description": "List of available payment gateways.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "A currency for which gateways will be returned. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `channel` argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentGateway",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableShippingMethods",
"description": "Shipping methods that are available for the shop.",
"args": [
{
"name": "address",
"description": "Address for which available shipping methods should be returned.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingMethod",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelCurrencies",
"description": "List of all currencies supported by shop's channels.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeTaxesOnShipping",
"description": "Charge taxes on shipping.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `ShippingMethodType.taxClass` to determine whether taxes are calculated for shipping methods; if a tax class is set, the taxes will be calculated, otherwise no tax rate will be applied."
},
{
"name": "companyAddress",
"description": "Company address.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "List of countries available in the shop.",
"args": [
{
"name": "filter",
"description": "Filtering options for countries",
"type": {
"kind": "INPUT_OBJECT",
"name": "CountryFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "A language code to return the translation for. \n\nDEPRECATED: this field will be removed in Saleor 4.0.",
"type": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerSetPasswordUrl",
"description": "URL of a view where customers can set their password.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultCountry",
"description": "Shop's default country.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultDigitalMaxDownloads",
"description": "Default number of max downloads per digital content URL.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultDigitalUrlValidDays",
"description": "Default number of days which digital content URL will be valid.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultMailSenderAddress",
"description": "Default shop's email sender's address.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultMailSenderName",
"description": "Default shop's email sender's name.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultWeightUnit",
"description": "Default weight unit.",
"args": [],
"type": {
"kind": "ENUM",
"name": "WeightUnitsEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "Shop's description.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Display prices with tax in store.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to determine whether to display gross or net prices."
},
{
"name": "domain",
"description": "Shop's domain data.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Domain",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "enableAccountConfirmationByEmail",
"description": "Determines if account confirmation by email is enabled.\n\nAdded in Saleor 3.14.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentAllowUnpaid",
"description": "Allow to approve fulfillments which are unpaid.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentAutoApprove",
"description": "Automatically approve all new fulfillments.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "headerText",
"description": "Header text.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "ID of the shop.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "includeTaxesInPrices",
"description": "Include taxes in prices.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax."
},
{
"name": "languages",
"description": "List of the shops's supported languages.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "limitQuantityPerCheckout",
"description": "Default number of maximum line quantity in single checkout (per single checkout line).\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "limits",
"description": "Resource limitations and current usage if any set for a shop\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LimitInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Shop's name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of available permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Permission",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "phonePrefixes",
"description": "List of possible phone prefixes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reserveStockDurationAnonymousUser",
"description": "Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reserveStockDurationAuthenticatedUser",
"description": "Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "schemaVersion",
"description": "Minor Saleor API version.\n\nAdded in Saleor 3.5.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffNotificationRecipients",
"description": "List of staff notification recipients.\n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffNotificationRecipient",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackInventoryByDefault",
"description": "Enable inventory tracking.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated shop fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for shop.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ShopTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor API version.\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopAddressUpdate",
"description": "Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Updated shop.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopDomainUpdate",
"description": "Updates site domain of the shop. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Updated shop.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "ShopErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ShopErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANNOT_FETCH_TAX_RATES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopFetchTaxRates",
"description": "Fetch tax rates. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Updated shop.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopMetadataUpdated",
"description": "Event sent when shop metadata is updated.\n\nAdded in Saleor 3.15.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Shop data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShopSettingsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "allowLoginWithoutConfirmation",
"description": "Enable possibility to login without account confirmation.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "automaticFulfillmentDigitalProducts",
"description": "Enable automatic fulfillment for all digital products.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeTaxesOnShipping",
"description": "Charge taxes on shipping. \n\nDEPRECATED: this field will be removed in Saleor 4.0. To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customerSetPasswordUrl",
"description": "URL of a view where customers can set their password.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultDigitalMaxDownloads",
"description": "Default number of max downloads per digital content URL.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultDigitalUrlValidDays",
"description": "Default number of days which digital content URL will be valid.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultMailSenderAddress",
"description": "Default email sender's address.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultMailSenderName",
"description": "Default email sender's name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultWeightUnit",
"description": "Default weight unit.",
"type": {
"kind": "ENUM",
"name": "WeightUnitsEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": "SEO description.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Display prices with tax in store. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "enableAccountConfirmationByEmail",
"description": "Enable automatic account confirmation by email.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentAllowUnpaid",
"description": "Enable ability to approve fulfillments which are unpaid.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fulfillmentAutoApprove",
"description": "Enable automatic approval of all new fulfillments.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "headerText",
"description": "Header text.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "includeTaxesInPrices",
"description": "Include taxes in prices. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "limitQuantityPerCheckout",
"description": "Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Shop public metadata.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Shop private metadata.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reserveStockDurationAnonymousUser",
"description": "Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reserveStockDurationAuthenticatedUser",
"description": "Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "trackInventoryByDefault",
"description": "Enable inventory tracking.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopSettingsTranslate",
"description": "Creates/updates translations for shop settings. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Updated shop settings.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "ShopSettingsTranslationInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "description",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "headerText",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopSettingsUpdate",
"description": "Updates shop settings. \n\nRequires one of the following permissions: MANAGE_SETTINGS.\n\nTriggers the following webhook events:\n- SHOP_METADATA_UPDATED (async): Optionally triggered when public or private metadata is updated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shop",
"description": "Updated shop.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Shop",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ShopTranslation",
"description": null,
"fields": [
{
"name": "description",
"description": "Translated description of sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "headerText",
"description": "Translated header text of sale.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the shop translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "SiteDomainInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "domain",
"description": "Domain name for shop.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Shop site name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffBulkDelete",
"description": "Deletes staff users. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_DELETED (async): A staff account was deleted.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffCreate",
"description": "Creates a new staff user. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_CREATED (async): A new staff account was created.\n- NOTIFY_USER (async): A notification for setting the password.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StaffCreateInput",
"description": "Fields required to create a staff user.",
"fields": null,
"inputFields": [
{
"name": "addGroups",
"description": "List of permission group IDs to which user should be assigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The unique email address of the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "Given name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "User account is active.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "Family name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the user metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "A note about the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the user private metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to set the password. URL in RFC 1808 format.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffCreated",
"description": "Event sent when new staff user is created.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffDelete",
"description": "Deletes a staff user. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_DELETED (async): A staff account was deleted.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffDeleted",
"description": "Event sent when staff user is deleted.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffError",
"description": null,
"fields": [
{
"name": "addressType",
"description": "A type of address that causes the error.",
"args": [],
"type": {
"kind": "ENUM",
"name": "AddressTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AccountErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "groups",
"description": "List of permission group IDs which cause the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissions",
"description": "List of permissions which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "users",
"description": "List of user IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "StaffMemberStatus",
"description": "Represents status of a staff account.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACTIVE",
"description": "User account has been activated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DEACTIVATED",
"description": "User account has not been activated yet.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffNotificationRecipient",
"description": "Represents a recipient of email notifications send by Saleor, such as notifications about new orders. Notifications can be assigned to staff users or arbitrary email addresses.",
"fields": [
{
"name": "active",
"description": "Determines if a notification active.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Returns email address of a user subscribed to email notifications.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the staff notification recipient.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "Returns a user subscribed to email notifications.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffNotificationRecipientCreate",
"description": "Creates a new staff notification recipient. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "staffNotificationRecipient",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "StaffNotificationRecipient",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffNotificationRecipientDelete",
"description": "Delete staff notification recipient. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "staffNotificationRecipient",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "StaffNotificationRecipient",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StaffNotificationRecipientInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "active",
"description": "Determines if a notification active.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "Email address of a user subscribed to email notifications.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The ID of the user subscribed to email notifications..",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffNotificationRecipientUpdate",
"description": "Updates a staff notification recipient. \n\nRequires one of the following permissions: MANAGE_SETTINGS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shopErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShopError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "staffNotificationRecipient",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "StaffNotificationRecipient",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffUpdate",
"description": "Updates an existing staff user. Apps are not allowed to perform this mutation. \n\nRequires one of the following permissions: MANAGE_STAFF.\n\nTriggers the following webhook events:\n- STAFF_UPDATED (async): A staff account was updated.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "staffErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StaffError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "user",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StaffUpdateInput",
"description": "Fields required to update a staff user.",
"fields": null,
"inputFields": [
{
"name": "addGroups",
"description": "List of permission group IDs to which user should be assigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The unique email address of the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "Given name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "User account is active.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "Family name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the user metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "A note about the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the user private metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeGroups",
"description": "List of permission group IDs from which user should be unassigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StaffUpdated",
"description": "Event sent when staff user is updated.\n\nAdded in Saleor 3.5.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "The user the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StaffUserInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"type": {
"kind": "ENUM",
"name": "StaffMemberStatus",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Stock",
"description": "Represents stock.",
"fields": [
{
"name": "id",
"description": "The ID of stock.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productVariant",
"description": "Information about the product variant.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityAllocated",
"description": "Quantity allocated for orders.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantityReserved",
"description": "Quantity reserved for checkouts.\n\nRequires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The warehouse associated with the stock.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "StockAvailability",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "IN_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OUT_OF_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StockBulkResult",
"description": null,
"fields": [
{
"name": "errors",
"description": "List of errors occurred on create or update attempt.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StockBulkUpdateError",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stock",
"description": "Stock data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Stock",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StockBulkUpdate",
"description": "Updates stocks for a given variant and warehouse.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were updated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StockBulkUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "results",
"description": "List of the updated stocks.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StockBulkResult",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StockBulkUpdateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "StockBulkUpdateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "StockBulkUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StockBulkUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "quantity",
"description": "Quantity of items available for sell.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantExternalReference",
"description": "Variant external reference.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantId",
"description": "Variant ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseExternalReference",
"description": "Warehouse external reference.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseId",
"description": "Warehouse ID.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StockCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "StockCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StockCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Stock",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StockError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "StockErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "StockErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StockFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "quantity",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StockInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "quantity",
"description": "Quantity of items available for sell.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "Warehouse in which stock is located.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "StockSettings",
"description": "Represents the channel stock settings.\n\nAdded in Saleor 3.7.",
"fields": [
{
"name": "allocationStrategy",
"description": "Allocation strategy defines the preference of warehouses for allocations and reservations.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AllocationStrategyEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StockSettingsInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "allocationStrategy",
"description": "Allocation strategy options. Strategy defines the preference of warehouses for allocations and reservations.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "AllocationStrategyEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StockUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "quantity",
"description": "Quantity of items available for sell.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stock",
"description": "Stock.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "StockUpdatePolicyEnum",
"description": "Determine how stocks should be updated, while processing an order.\n\n SKIP - stocks are not checked and not updated.\n UPDATE - only do update, if there is enough stock.\n FORCE - force update, if there is not enough stock.\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FORCE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SKIP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UPDATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "StorePaymentMethodEnum",
"description": "Enum representing the type of a payment storage in a gateway.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NONE",
"description": "Storage is disabled. The payment is not stored.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OFF_SESSION",
"description": "Off session storage type. The payment is stored to be reused even if the customer is absent.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ON_SESSION",
"description": "On session storage type. The payment is stored only to be reused when the customer is present in the checkout flow.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "String",
"description": "The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "StringFilterInput",
"description": "Define the filtering options for string fields.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": null,
"inputFields": [
{
"name": "eq",
"description": "The value equal to.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "oneOf",
"description": "The value included in.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Subscription",
"description": null,
"fields": [
{
"name": "event",
"description": "Look up subscription event.\n\nAdded in Saleor 3.2.",
"args": [],
"type": {
"kind": "INTERFACE",
"name": "Event",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxCalculationStrategy",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FLAT_RATES",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TAX_APP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClass",
"description": "Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates.\n\nAdded in Saleor 3.9.",
"fields": [
{
"name": "countries",
"description": "Country-specific tax rates for this tax class.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxClassCountryRate",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the tax class.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxClassCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassCountryRate",
"description": "Tax rate for a country. When tax class is null, it represents the default tax rate for that country; otherwise it's a country tax rate specific to the given tax class.\n\nAdded in Saleor 3.9.",
"fields": [
{
"name": "country",
"description": "Country in which this tax rate applies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "rate",
"description": "Tax rate value.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": "Related tax class.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassCreate",
"description": "Create a tax class.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxClassCreateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassCreateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxClassCreateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCodes",
"description": "List of country codes for which the configuration is invalid.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxClassCreateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxClassCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "createCountryRates",
"description": "List of country-specific tax rates to create for this tax class.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CountryRateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the tax class.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassDelete",
"description": "Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxClassDeleteError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassDeleteError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxClassDeleteErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxClassDeleteErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxClassFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "countries",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxClassRateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "rate",
"description": "Tax rate value.",
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassId",
"description": "ID of a tax class for which to update the tax rate",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxClassSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort tax classes by name.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxClassSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort tax classes.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort tax classes by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxClassSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassUpdate",
"description": "Update a tax class.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxClassUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClass",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxClass",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxClassUpdateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxClassUpdateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCodes",
"description": "List of country codes for which the configuration is invalid.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxClassUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxClassUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "name",
"description": "Name of the tax class.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeCountryRates",
"description": "List of country codes for which to remove the tax class rates. Note: It removes all rates for given country code.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updateCountryRates",
"description": "List of country-specific tax rates to create or update for this tax class.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "CountryRateUpdateInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxConfiguration",
"description": "Channel-specific tax configuration.\n\nAdded in Saleor 3.9.",
"fields": [
{
"name": "channel",
"description": "A channel to which the tax configuration applies to.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargeTaxes",
"description": "Determines whether taxes are charged in the given channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "List of country-specific exceptions in tax configuration.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxConfigurationPerCountry",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Determines whether prices displayed in a storefront should include taxes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pricesEnteredWithTax",
"description": "Determines whether prices are entered with the tax included.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCalculationStrategy",
"description": "The default strategy to use for tax calculation in the given channel. Taxes can be calculated either using user-defined flat rates or with a tax app. Empty value means that no method is selected and taxes are not calculated.",
"args": [],
"type": {
"kind": "ENUM",
"name": "TaxCalculationStrategy",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxConfigurationCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxConfigurationCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxConfigurationCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxConfiguration",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxConfigurationFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxConfigurationPerCountry",
"description": "Country-specific exceptions of a channel's tax configuration.\n\nAdded in Saleor 3.9.",
"fields": [
{
"name": "chargeTaxes",
"description": "Determines whether taxes are charged in this country.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "country",
"description": "Country in which this configuration applies.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Determines whether prices displayed in a storefront should include taxes for this country.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCalculationStrategy",
"description": "A country-specific strategy to use for tax calculation. Taxes can be calculated either using user-defined flat rates or with a tax app. If not provided, use the value from the channel's tax configuration.",
"args": [],
"type": {
"kind": "ENUM",
"name": "TaxCalculationStrategy",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxConfigurationPerCountryInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "chargeTaxes",
"description": "Determines whether taxes are charged in this country.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCode",
"description": "Country in which this configuration applies.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Determines whether prices displayed in a storefront should include taxes for this country.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCalculationStrategy",
"description": "A country-specific strategy to use for tax calculation. Taxes can be calculated either using user-defined flat rates or with a tax app. If not provided, use the value from the channel's tax configuration.",
"type": {
"kind": "ENUM",
"name": "TaxCalculationStrategy",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxConfigurationUpdate",
"description": "Update tax configuration for a channel.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxConfigurationUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxConfiguration",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxConfiguration",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxConfigurationUpdateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxConfigurationUpdateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countryCodes",
"description": "List of country codes for which the configuration is invalid.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxConfigurationUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DUPLICATED_INPUT_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxConfigurationUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "chargeTaxes",
"description": "Determines whether taxes are charged in the given channel.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "displayGrossPrices",
"description": "Determines whether prices displayed in a storefront should include taxes.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pricesEnteredWithTax",
"description": "Determines whether prices are entered with the tax included.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeCountriesConfiguration",
"description": "List of country codes for which to remove the tax configuration.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "CountryCode",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCalculationStrategy",
"description": "The default strategy to use for tax calculation in the given channel. Taxes can be calculated either using user-defined flat rates or with a tax app. Empty value means that no method is selected and taxes are not calculated.",
"type": {
"kind": "ENUM",
"name": "TaxCalculationStrategy",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updateCountriesConfiguration",
"description": "List of tax country configurations to create or update (identified by a country code).",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "TaxConfigurationPerCountryInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxCountryConfiguration",
"description": "Tax class rates grouped by country.\n\nAdded in Saleor 3.9.",
"fields": [
{
"name": "country",
"description": "A country for which tax class rates are grouped.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassCountryRates",
"description": "List of tax class rates.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxClassCountryRate",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxCountryConfigurationDelete",
"description": "Remove all tax class rates for a specific country.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxCountryConfigurationDeleteError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCountryConfiguration",
"description": "Updated tax class rates grouped by a country.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxCountryConfiguration",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxCountryConfigurationDeleteError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxCountryConfigurationDeleteErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxCountryConfigurationDeleteErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxCountryConfigurationUpdate",
"description": "Update tax class rates for a specific country.\n\nAdded in Saleor 3.9. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxCountryConfigurationUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCountryConfiguration",
"description": "Updated tax class rates grouped by a country.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxCountryConfiguration",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxCountryConfigurationUpdateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxCountryConfigurationUpdateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxClassIds",
"description": "List of tax class IDs for which the update failed.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxCountryConfigurationUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANNOT_CREATE_NEGATIVE_RATE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ONLY_ONE_DEFAULT_COUNTRY_RATE_ALLOWED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxExemptionManage",
"description": "Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known.\n\nAdded in Saleor 3.8. \n\nRequires one of the following permissions: MANAGE_TAXES.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxExemptionManageError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxableObject",
"description": null,
"args": [],
"type": {
"kind": "UNION",
"name": "TaxSourceObject",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxExemptionManageError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TaxExemptionManageErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TaxExemptionManageErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_EDITABLE_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "UNION",
"name": "TaxSourceLine",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "CheckoutLine",
"ofType": null
},
{
"kind": "OBJECT",
"name": "OrderLine",
"ofType": null
}
]
},
{
"kind": "UNION",
"name": "TaxSourceObject",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "TaxType",
"description": "Representation of tax types fetched from tax gateway.",
"fields": [
{
"name": "description",
"description": "Description of the tax type.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "taxCode",
"description": "External tax code used to identify given tax group.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxableObject",
"description": "Taxable object.",
"fields": [
{
"name": "address",
"description": "The address data.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "The currency of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discounts",
"description": "List of discounts.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxableObjectDiscount",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lines",
"description": "List of lines assigned to the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TaxableObjectLine",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pricesEnteredWithTax",
"description": "Determines if prices contain entered tax..",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingPrice",
"description": "The price of shipping method.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceObject",
"description": "The source object related to this tax object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "TaxSourceObject",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxableObjectDiscount",
"description": "Taxable object discount.",
"fields": [
{
"name": "amount",
"description": "The amount of the discount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the discount.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxableObjectLine",
"description": null,
"fields": [
{
"name": "chargeTaxes",
"description": "Determines if taxes are being charged for the product.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productName",
"description": "The product name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productSku",
"description": "The product sku.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "quantity",
"description": "Number of items.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceLine",
"description": "The source line related to this tax line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "TaxSourceLine",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalPrice",
"description": "Price of the order line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "unitPrice",
"description": "Price of the single item in the order line.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variantName",
"description": "The variant name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxedMoney",
"description": "Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal.",
"fields": [
{
"name": "currency",
"description": "Currency code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gross",
"description": "Amount of money including taxes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "net",
"description": "Amount of money without taxes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "tax",
"description": "Amount of taxes.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TaxedMoneyInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "gross",
"description": "Gross value of an item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "net",
"description": "Net value of an item.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TaxedMoneyRange",
"description": "Represents a range of monetary values.",
"fields": [
{
"name": "start",
"description": "Lower bound of a price range.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "stop",
"description": "Upper bound of a price range.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "ThumbnailCreated",
"description": "Event sent when thumbnail is created.\n\nAdded in Saleor 3.12.",
"fields": [
{
"name": "id",
"description": "Thumbnail id.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "mediaUrl",
"description": "Original media url.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "objectId",
"description": "Object the thumbnail refers to.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "Thumbnail url.\n\nAdded in Saleor 3.12.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AVIF",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORIGINAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WEBP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TimePeriod",
"description": null,
"fields": [
{
"name": "amount",
"description": "The length of the period.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of the period.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TimePeriodTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TimePeriodInputType",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amount",
"description": "The length of the period.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of the period.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TimePeriodTypeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TimePeriodTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DAY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MONTH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WEEK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "YEAR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Transaction",
"description": "An object representing a single payment.",
"fields": [
{
"name": "amount",
"description": "Total amount of the transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "created",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "error",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "gatewayResponse",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isSuccess",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "kind",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionKind",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payment",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Payment",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "token",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionAction",
"description": null,
"fields": [
{
"name": "actionType",
"description": "Determines the action type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionActionEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amount",
"description": "Transaction request amount. Null when action type is VOID.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionActionEnum",
"description": "Represents possible actions on payment transaction.\n\n The following actions are possible:\n CHARGE - Represents the charge action.\n REFUND - Represents a refund action.\n CANCEL - Represents a cancel action. Added in Saleor 3.12.\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CANCEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionCancelationRequested",
"description": "Event sent when transaction cancelation is requested.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "action",
"description": "Requested action data.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionAction",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Look up a transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionChargeRequested",
"description": "Event sent when transaction charge is requested.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "action",
"description": "Requested action data.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionAction",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Look up a transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionCreate",
"description": "Create transaction for checkout or order.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: HANDLE_PAYMENTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionCreateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionCreateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionCreateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionCreateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCORRECT_CURRENCY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "METADATA_KEY_REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TransactionCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amountAuthorized",
"description": "Amount authorized by this transaction.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amountCanceled",
"description": "Amount canceled by this transaction.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amountCharged",
"description": "Amount charged by this transaction.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amountRefunded",
"description": "Amount refunded by this transaction.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableActions",
"description": "List of all possible actions for the transaction",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionActionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalUrl",
"description": "The url that will allow to redirect user to payment provider page with transaction event details.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The message of the transaction.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Payment public metadata.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Payment name of the transaction.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Payment private metadata.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pspReference",
"description": "PSP Reference of the transaction. \n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionEvent",
"description": "Represents transaction's event.",
"fields": [
{
"name": "amount",
"description": "The amount related to this event.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdBy",
"description": "User or App that created the transaction event.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "UNION",
"name": "UserOrApp",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalUrl",
"description": "The url that will allow to redirect user to payment provider page with transaction details.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Message related to the transaction's event.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pspReference",
"description": "PSP reference of transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "The type of action related to this event.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "ENUM",
"name": "TransactionEventTypeEnum",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TransactionEventInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "message",
"description": "The message related to the event.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pspReference",
"description": "PSP Reference related to this action.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionEventReport",
"description": "Report the event for the transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app.",
"fields": [
{
"name": "alreadyProcessed",
"description": "Defines if the reported event hasn't been processed earlier.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionEventReportError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "The transaction related to the reported event.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionEvent",
"description": "The event assigned to this report. if `alreadyProcessed` is set to `true`, the previously processed event will be returned.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionEventReportError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionEventReportErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionEventReportErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCORRECT_DETAILS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionEventTypeEnum",
"description": "Represents possible event types.\n\n Added in Saleor 3.12.\n\n The following types are possible:\n AUTHORIZATION_SUCCESS - represents success authorization.\n AUTHORIZATION_FAILURE - represents failure authorization.\n AUTHORIZATION_ADJUSTMENT - represents authorization adjustment.\n AUTHORIZATION_REQUEST - represents authorization request.\n AUTHORIZATION_ACTION_REQUIRED - represents authorization that needs\n additional actions from the customer.\n CHARGE_ACTION_REQUIRED - represents charge that needs\n additional actions from the customer.\n CHARGE_SUCCESS - represents success charge.\n CHARGE_FAILURE - represents failure charge.\n CHARGE_BACK - represents chargeback.\n CHARGE_REQUEST - represents charge request.\n REFUND_SUCCESS - represents success refund.\n REFUND_FAILURE - represents failure refund.\n REFUND_REVERSE - represents reverse refund.\n REFUND_REQUEST - represents refund request.\n CANCEL_SUCCESS - represents success cancel.\n CANCEL_FAILURE - represents failure cancel.\n CANCEL_REQUEST - represents cancel request.\n INFO - represents info event.\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AUTHORIZATION_ACTION_REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTHORIZATION_ADJUSTMENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTHORIZATION_FAILURE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTHORIZATION_REQUEST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTHORIZATION_SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCEL_FAILURE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCEL_REQUEST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCEL_SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE_ACTION_REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE_BACK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE_FAILURE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE_REQUEST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE_SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INFO",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND_FAILURE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND_REQUEST",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND_REVERSE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND_SUCCESS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionFlowStrategyEnum",
"description": "Determine the transaction flow strategy.\n\n AUTHORIZATION - the processed transaction should be only authorized\n CHARGE - the processed transaction should be charged.\n ",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "AUTHORIZATION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHARGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionInitialize",
"description": "Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. \n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "data",
"description": "The JSON data required to finalize the payment.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionInitializeError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "The initialized transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionEvent",
"description": "The event created for the initialized transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionInitializeError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionInitializeErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionInitializeErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionInitializeSession",
"description": "Event sent when user starts processing the payment.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "action",
"description": "Action to proceed for the transaction",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionProcessAction",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "data",
"description": "Payment gateway data in JSON format, recieved from storefront.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "merchantReference",
"description": "Merchant reference assigned to this payment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceObject",
"description": "Checkout or order",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "OrderOrCheckout",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Look up a transaction.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionItem",
"description": "Represents a payment transaction.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "actions",
"description": "List of actions that can be performed in the current state of a payment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionActionEnum",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "authorizePendingAmount",
"description": "Total amount of ongoing authorization requests for the transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "authorizedAmount",
"description": "Total amount authorized for this payment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "cancelPendingAmount",
"description": "Total amount of ongoing cancel requests for the transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "canceledAmount",
"description": "Total amount canceled for this payment.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargePendingAmount",
"description": "Total amount of ongoing charge requests for the transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "chargedAmount",
"description": "Total amount charged for this payment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdAt",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "createdBy",
"description": "User or App that created the transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "UNION",
"name": "UserOrApp",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "List of all transaction's events.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionEvent",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalUrl",
"description": "The url that will allow to redirect user to payment provider page with transaction details.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "Message related to the transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "modifiedAt",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Name of the transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "order",
"description": "The related order.\n\nAdded in Saleor 3.6.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pspReference",
"description": "PSP reference of transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refundPendingAmount",
"description": "Total amount of ongoing refund requests for the transaction.\n\nAdded in Saleor 3.13.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "refundedAmount",
"description": "Total amount refunded for this payment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionItemMetadataUpdated",
"description": "Event sent when transaction item metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Look up a transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionKind",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACTION_TO_CONFIRM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "AUTH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CANCEL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CAPTURE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CONFIRM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EXTERNAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PENDING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REFUND_ONGOING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionProcess",
"description": "Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. \n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "data",
"description": "The json data required to finalize the payment.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionProcessError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "The processed transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transactionEvent",
"description": "The event created for the processed transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionEvent",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionProcessAction",
"description": null,
"fields": [
{
"name": "actionType",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionFlowStrategyEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amount",
"description": "Transaction amount to process.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency of the amount.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionProcessError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionProcessErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionProcessErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_PAYMENT_APP",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_PAYMENT_APP_RELATION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_ALREADY_PROCESSED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionProcessSession",
"description": "Event sent when user has additional payment action to process.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "action",
"description": "Action to proceed for the transaction",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionProcessAction",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "data",
"description": "Payment gateway data in JSON format, recieved from storefront.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSON",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "merchantReference",
"description": "Merchant reference assigned to this payment.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourceObject",
"description": "Checkout or order",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "OrderOrCheckout",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Look up a transaction.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionRefundRequested",
"description": "Event sent when transaction refund is requested.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"fields": [
{
"name": "action",
"description": "Requested action data.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionAction",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "grantedRefund",
"description": "Granted refund related to refund request.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "OrderGrantedRefund",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": "Look up a transaction.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionRequestAction",
"description": "Request an action for payment transaction.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: HANDLE_PAYMENTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionRequestActionError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionRequestActionError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionRequestActionErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionRequestActionErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionRequestRefundForGrantedRefund",
"description": "Request a refund for payment transaction based on granted refund.\n\nAdded in Saleor 3.15.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: HANDLE_PAYMENTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionRequestRefundForGrantedRefundError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionRequestRefundForGrantedRefundError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionRequestRefundForGrantedRefundErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionRequestRefundForGrantedRefundErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionUpdate",
"description": "Update transaction.\n\nAdded in Saleor 3.4.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.\n\nRequires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TransactionUpdateError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "transaction",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "TransactionItem",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TransactionUpdateError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionUpdateErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TransactionUpdateErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INCORRECT_CURRENCY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "METADATA_KEY_REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TransactionUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "amountAuthorized",
"description": "Amount authorized by this transaction.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amountCanceled",
"description": "Amount canceled by this transaction.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amountCharged",
"description": "Amount charged by this transaction.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "amountRefunded",
"description": "Amount refunded by this transaction.",
"type": {
"kind": "INPUT_OBJECT",
"name": "MoneyInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "availableActions",
"description": "List of all possible actions for the transaction",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TransactionActionEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalUrl",
"description": "The url that will allow to redirect user to payment provider page with transaction event details.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The message of the transaction.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Payment public metadata.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Payment name of the transaction.\n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Payment private metadata.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pspReference",
"description": "PSP Reference of the transaction. \n\nAdded in Saleor 3.13.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "TranslatableItem",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AttributeTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValueTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CategoryTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItemTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodTranslatableContent",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherTranslatableContent",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "TranslatableItemConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslatableItemEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TranslatableItemEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "UNION",
"name": "TranslatableItem",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TranslatableKinds",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ATTRIBUTE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_METHOD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TranslationCreated",
"description": "Event sent when new translation is created.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "The translation the event relates to.",
"args": [],
"type": {
"kind": "UNION",
"name": "TranslationTypes",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "TranslationError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "TranslationErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "TranslationErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "TranslationInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "description",
"description": "Translated description.\n\nRich text format. For reference see https://editorjs.io/",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoDescription",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "seoTitle",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "TranslationTypes",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "AttributeTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "AttributeValueTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CategoryTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "CollectionTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "MenuItemTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariantTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "SaleTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ShippingMethodTranslation",
"ofType": null
},
{
"kind": "OBJECT",
"name": "VoucherTranslation",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "TranslationUpdated",
"description": "Event sent when translation is updated.\n\nAdded in Saleor 3.2.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "The translation the event relates to.",
"args": [],
"type": {
"kind": "UNION",
"name": "TranslationTypes",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "UUID",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "UpdateInvoiceInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "metadata",
"description": "Fields required to update the invoice metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "number",
"description": "Invoice number",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the invoice private metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "url",
"description": "URL of an invoice to download.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UpdateMetadata",
"description": "Updates metadata of an object. To use it, you need to have access to the modified object.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "item",
"description": null,
"args": [],
"type": {
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadataErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UpdatePrivateMetadata",
"description": "Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "item",
"description": null,
"args": [],
"type": {
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadataErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "Upload",
"description": "Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UploadError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "UploadErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "UploadErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "User",
"description": "Represents user data.",
"fields": [
{
"name": "accessibleChannels",
"description": "List of channels the user has access to. The sum of channels from all user groups. If at least one group has `restrictedAccessToChannels` set to False - all channels are returned.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "addresses",
"description": "List of all user's addresses.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "avatar",
"description": "The avatar of the user.",
"args": [
{
"name": "format",
"description": "The format of the image. When not provided, format of the original image will be used.\n\nAdded in Saleor 3.6.",
"type": {
"kind": "ENUM",
"name": "ThumbnailFormatEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "size",
"description": "Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Image",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkout",
"description": "Returns the last open checkout of this user.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Checkout",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use the `checkoutTokens` field to fetch the user checkouts."
},
{
"name": "checkoutIds",
"description": "Returns the checkout ID's assigned to this user.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "checkoutTokens",
"description": "Returns the checkout UUID's assigned to this user.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "UUID",
"ofType": null
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `checkoutIds` instead."
},
{
"name": "checkouts",
"description": "Returns checkouts assigned to this user.\n\nAdded in Saleor 3.8.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CheckoutCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "dateJoined",
"description": "The data when the user create account.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultBillingAddress",
"description": "The default billing address of the user.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultShippingAddress",
"description": "The default shipping address of the user.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "editableGroups",
"description": "List of user's permission groups which user can manage.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The email address of the user.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "List of events associated with the user.\n\nRequires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CustomerEvent",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this user. \n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "The given name of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "giftCards",
"description": "List of the user gift cards.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "GiftCardCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the user.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if the user is active.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isConfirmed",
"description": "Determines if user has confirmed email.\n\nAdded in Saleor 3.15.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isStaff",
"description": "Determine if the user is a staff admin.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "User language code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastLogin",
"description": "The date when the user last time log in to the system.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "The family name of the address.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "A note about the customer.\n\nRequires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "orders",
"description": "List of user's orders. Requires one of the following permissions: MANAGE_STAFF, OWNER.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "OrderCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "permissionGroups",
"description": "List of user's permission groups.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "restrictedAccessToChannels",
"description": "Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "storedPaymentSources",
"description": "List of stored payment sources.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PaymentSource",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "updatedAt",
"description": "The data when the user last update the account information.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "userPermissions",
"description": "List of user's permissions.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserPermission",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UserAvatarDelete",
"description": "Deletes a user avatar. Only for staff members. \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "An updated user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UserAvatarUpdate",
"description": "Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "An updated user instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UserBulkSetActive",
"description": "Activate or deactivate users. \n\nRequires one of the following permissions: MANAGE_USERS.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UserCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "UserCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "UserCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "User",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "UserCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Slug of a channel which will be used for notify user. Optional when only one channel exists.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultBillingAddress",
"description": "Billing address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultShippingAddress",
"description": "Shipping address of the customer.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The unique email address of the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the customer.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "firstName",
"description": "Given name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "User account is active.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isConfirmed",
"description": "User account is confirmed.\n\nAdded in Saleor 3.15.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "languageCode",
"description": "User language code.",
"type": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lastName",
"description": "Family name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "Fields required to update the user metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "note",
"description": "A note about the user.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "Fields required to update the user private metadata.\n\nAdded in Saleor 3.14.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "redirectUrl",
"description": "URL of a view where users should be redirected to set the password. URL in RFC 1808 format.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "UserOrApp",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "App",
"ofType": null
},
{
"kind": "OBJECT",
"name": "User",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "UserPermission",
"description": "Represents user's permissions.",
"fields": [
{
"name": "code",
"description": "Internal code for permission.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "PermissionEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Describe action(s) allowed to do by permission.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sourcePermissionGroups",
"description": "List of user permission groups which contains this permission.",
"args": [
{
"name": "userId",
"description": "ID of user whose groups should be returned.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Group",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "UserSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CREATED_AT",
"description": "Sort users by created at.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "EMAIL",
"description": "Sort users by email.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FIRST_NAME",
"description": "Sort users by first name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_MODIFIED_AT",
"description": "Sort users by last modified at.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LAST_NAME",
"description": "Sort users by last name.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_COUNT",
"description": "Sort users by order count.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "UserSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort users.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort users by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "UserSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VAT",
"description": "Represents a VAT rate for a country.",
"fields": [
{
"name": "countryCode",
"description": "Country code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "reducedRates",
"description": "Country's VAT rate exceptions for specific types of goods.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ReducedRate",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "standardRate",
"description": "Standard VAT rate in percent.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "VariantAttributeScope",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_VARIANT_SELECTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIANT_SELECTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VariantMediaAssign",
"description": "Assign an media to a product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productVariant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VariantMediaUnassign",
"description": "Unassign an media from a product variant. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "media",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "productErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ProductError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "productVariant",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VariantPricingInfo",
"description": "Represents availability of a variant in the storefront.",
"fields": [
{
"name": "discount",
"description": "The discount amount if in sale (null otherwise).",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountLocalCurrency",
"description": "The discount amount in the local currency.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Always returns `null`."
},
{
"name": "onSale",
"description": "Whether it is in sale or not.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "price",
"description": "The price, with any discount subtracted.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "priceLocalCurrency",
"description": "The discounted price in the local currency.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Always returns `null`."
},
{
"name": "priceUndiscounted",
"description": "The price without any discount.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "TaxedMoney",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VerifyToken",
"description": "Verify JWT token.",
"fields": [
{
"name": "accountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "AccountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isValid",
"description": "Determine if token is valid or not.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payload",
"description": "JWT payload.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "GenericScalar",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "user",
"description": "User assigned to token.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "User",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "VolumeUnitsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACRE_FT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACRE_IN",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_CENTIMETER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_DECIMETER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_FOOT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_INCH",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_METER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_MILLIMETER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUBIC_YARD",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FL_OZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LITER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PINT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "QT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Voucher",
"description": "Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.",
"fields": [
{
"name": "applyOncePerCustomer",
"description": "Determine if the voucher usage should be limited to one use per customer.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "applyOncePerOrder",
"description": "Determine if the voucher should be applied once per order. If set to True, the voucher is applied to a single cheapest eligible product in checkout.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categories",
"description": "List of categories this voucher applies to.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CategoryCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "channelListings",
"description": "List of availability in channels for the voucher.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "VoucherChannelListing",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "The code of the voucher.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "List of collections this voucher applies to.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "CollectionCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "List of countries available for the shipping voucher.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "CountryDisplay",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency code for voucher.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValue",
"description": "Voucher value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValueType",
"description": "Determines a type of discount for voucher - value or percentage",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endDate",
"description": "The end date and time of voucher.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the voucher.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minCheckoutItemsQuantity",
"description": "Determine minimum quantity of items for checkout.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minSpent",
"description": "Minimum order value to apply voucher.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the voucher.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "onlyForStaff",
"description": "Determine if the voucher is available only for staff members.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "List of products this voucher applies to.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startDate",
"description": "The start date and time of voucher.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated voucher fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Determines a type of voucher.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "VoucherTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageLimit",
"description": "The number of times a voucher can be used.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "used",
"description": "Usage count of the voucher.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "List of product variants this voucher applies to.\n\nAdded in Saleor 3.1.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "ProductVariantCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherAddCatalogues",
"description": "Adds products, categories, collections to a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "Voucher of which catalogue IDs will be modified.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherBulkDelete",
"description": "Deletes vouchers. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_DELETED (async): A voucher was deleted.",
"fields": [
{
"name": "count",
"description": "Returns how many objects were affected.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherChannelListing",
"description": "Represents voucher channel listing.",
"fields": [
{
"name": "channel",
"description": "The channel in which voucher can be applied.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Channel",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "currency",
"description": "Currency code for voucher in a channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValue",
"description": "The value of the discount on voucher in a channel.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of channel listing.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minSpent",
"description": "Minimum order value for voucher to apply in channel.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Money",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "VoucherChannelListingAddInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channelId",
"description": "ID of a channel.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValue",
"description": "Value of the voucher.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minAmountSpent",
"description": "Min purchase amount required to apply the voucher.",
"type": {
"kind": "SCALAR",
"name": "PositiveDecimal",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "VoucherChannelListingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "addChannels",
"description": "List of channels to which the voucher should be assigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "VoucherChannelListingAddInput",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "removeChannels",
"description": "List of channels from which the voucher should be unassigned.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherChannelListingUpdate",
"description": "Manage voucher's availability in channels. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "An updated voucher instance.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "VoucherCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherCreate",
"description": "Creates a new voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_CREATED (async): A voucher was created.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherCreated",
"description": "Event sent when new voucher is created.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "The voucher the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherDelete",
"description": "Deletes a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_DELETED (async): A voucher was deleted.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherDeleted",
"description": "Event sent when voucher is deleted.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "The voucher the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "VoucherDiscountType",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "FIXED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERCENTAGE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "VoucherFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "discountType",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "VoucherDiscountType",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "MetadataFilter",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "started",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "DateTimeRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "status",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "DiscountStatusEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "timesUsed",
"description": null,
"type": {
"kind": "INPUT_OBJECT",
"name": "IntRangeInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "VoucherInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "applyOncePerCustomer",
"description": "Voucher should be applied once per customer.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "applyOncePerOrder",
"description": "Voucher should be applied to the cheapest item or entire order.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "categories",
"description": "Categories discounted by the voucher.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "code",
"description": "Code to use the voucher.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "collections",
"description": "Collections discounted by the voucher.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "countries",
"description": "Country codes that can be used with the shipping voucher.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "discountValueType",
"description": "Choices: fixed or percentage.",
"type": {
"kind": "ENUM",
"name": "DiscountValueTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "endDate",
"description": "End date of the voucher in ISO 8601 format.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "minCheckoutItemsQuantity",
"description": "Minimal quantity of checkout items required to apply the voucher.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Voucher name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "onlyForStaff",
"description": "Voucher can be used only by staff user.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "products",
"description": "Products discounted by the voucher.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "startDate",
"description": "Start date of the voucher in ISO 8601 format.",
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": "Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER.",
"type": {
"kind": "ENUM",
"name": "VoucherTypeEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "usageLimit",
"description": "Limit number of times this voucher can be used in total.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "variants",
"description": "Variants discounted by the voucher.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherMetadataUpdated",
"description": "Event sent when voucher metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "The voucher the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherRemoveCatalogues",
"description": "Removes products, categories, collections from a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "Voucher of which catalogue IDs will be modified.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "VoucherSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CODE",
"description": "Sort vouchers by code.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "END_DATE",
"description": "Sort vouchers by end date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MINIMUM_SPENT_AMOUNT",
"description": "Sort vouchers by minimum spent amount.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "START_DATE",
"description": "Sort vouchers by start date.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TYPE",
"description": "Sort vouchers by type.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "USAGE_LIMIT",
"description": "Sort vouchers by usage limit.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VALUE",
"description": "Sort vouchers by value.\n\nThis option requires a channel filter to work as the values can vary between channels.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "VoucherSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channel",
"description": "Specifies the channel in which to sort the data.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "direction",
"description": "Specifies the direction in which to sort vouchers.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort vouchers by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "VoucherSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherTranslatableContent",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the voucher translatable content.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Voucher name to translate.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translation",
"description": "Returns translated voucher fields for the given language code.",
"args": [
{
"name": "languageCode",
"description": "A language code to return the translation for voucher.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "LanguageCodeEnum",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "VoucherTranslation",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.\n\nRequires one of the following permissions: MANAGE_DISCOUNTS.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Get model fields from the root level queries."
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherTranslate",
"description": "Creates/updates translations for a voucher. \n\nRequires one of the following permissions: MANAGE_TRANSLATIONS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "translationErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "TranslationError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "voucher",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherTranslation",
"description": null,
"fields": [
{
"name": "id",
"description": "The ID of the voucher translation.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "language",
"description": "Translation language.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "LanguageDisplay",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Translated voucher name.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "VoucherTypeEnum",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ENTIRE_ORDER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SPECIFIC_PRODUCT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherUpdate",
"description": "Updates a voucher. \n\nRequires one of the following permissions: MANAGE_DISCOUNTS.\n\nTriggers the following webhook events:\n- VOUCHER_UPDATED (async): A voucher was updated.",
"fields": [
{
"name": "discountErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "DiscountError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "VoucherUpdated",
"description": "Event sent when voucher is updated.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "voucher",
"description": "The voucher the event relates to.",
"args": [
{
"name": "channel",
"description": "Slug of a channel for which the data should be returned.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "Voucher",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Warehouse",
"description": "Represents warehouse.",
"fields": [
{
"name": "address",
"description": "Address of the warehouse.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Address",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "clickAndCollectOption",
"description": "Click and collect options: local, all or disabled.\n\nAdded in Saleor 3.1.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WarehouseClickAndCollectOptionEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "companyName",
"description": "Warehouse company name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `Address.companyName` instead."
},
{
"name": "email",
"description": "Warehouse email.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of this warehouse. \n\nAdded in Saleor 3.10.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "id",
"description": "The ID of the warehouse.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPrivate",
"description": "Determine if the warehouse is private.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metadata",
"description": "List of public metadata items. Can be accessed without permissions.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafield",
"description": "A single key from public metadata.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "metafields",
"description": "Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Warehouse name.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetadata",
"description": "List of private metadata items. Requires staff permissions to access.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "MetadataItem",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafield",
"description": "A single key from private metadata. Requires staff permissions to access.\n\nTip: Use GraphQL aliases to fetch multiple keys.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "key",
"description": null,
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "privateMetafields",
"description": "Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.\n\nAdded in Saleor 3.3.",
"args": [
{
"name": "keys",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "SCALAR",
"name": "Metadata",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZones",
"description": "Shipping zones supported by the warehouse.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "ShippingZoneCountableConnection",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Warehouse slug.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
{
"kind": "INTERFACE",
"name": "ObjectWithMetadata",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WarehouseClickAndCollectOptionEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DISABLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LOCAL",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseCountableConnection",
"description": null,
"fields": [
{
"name": "edges",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseCountableEdge",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "pageInfo",
"description": "Pagination data for this connection.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "PageInfo",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "totalCount",
"description": "A total count of items in the collection.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseCountableEdge",
"description": null,
"fields": [
{
"name": "cursor",
"description": "A cursor for use in pagination.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "node",
"description": "The item at the end of the edge.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseCreate",
"description": "Creates new warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "WarehouseCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "address",
"description": "Address of the warehouse.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The email address of the warehouse.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the warehouse.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Warehouse name.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZones",
"description": "Shipping zones supported by the warehouse.\n\nDEPRECATED: this field will be removed in Saleor 4.0. Providing the zone ids will raise a ValidationError.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Warehouse slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseCreated",
"description": "Event sent when new warehouse is created.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The warehouse the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseDelete",
"description": "Deletes selected warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseDeleted",
"description": "Event sent when warehouse is deleted.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The warehouse the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WarehouseErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "shippingZones",
"description": "List of shipping zones IDs which causes the error.",
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WarehouseErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ALREADY_EXISTS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "WarehouseFilterInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "channels",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "clickAndCollectOption",
"description": null,
"type": {
"kind": "ENUM",
"name": "WarehouseClickAndCollectOptionEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ids",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPrivate",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "search",
"description": null,
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slugs",
"description": null,
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseMetadataUpdated",
"description": "Event sent when warehouse metadata is updated.\n\nAdded in Saleor 3.8.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The warehouse the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseShippingZoneAssign",
"description": "Add shipping zone to given warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseShippingZoneUnassign",
"description": "Remove shipping zone from given warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WarehouseSortField",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "NAME",
"description": "Sort warehouses by name.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "WarehouseSortingInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "direction",
"description": "Specifies the direction in which to sort warehouses.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "OrderDirection",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Sort warehouses by the selected field.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WarehouseSortField",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseUpdate",
"description": "Updates given warehouse. \n\nRequires one of the following permissions: MANAGE_PRODUCTS.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouseErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WarehouseError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "WarehouseUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "address",
"description": "Address of the warehouse.",
"type": {
"kind": "INPUT_OBJECT",
"name": "AddressInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "clickAndCollectOption",
"description": "Click and collect options: local, all or disabled.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "ENUM",
"name": "WarehouseClickAndCollectOptionEnum",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "email",
"description": "The email address of the warehouse.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "externalReference",
"description": "External ID of the warehouse.\n\nAdded in Saleor 3.10.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isPrivate",
"description": "Visibility of warehouse stocks.\n\nAdded in Saleor 3.1.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Warehouse name.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "slug",
"description": "Warehouse slug.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WarehouseUpdated",
"description": "Event sent when warehouse is updated.\n\nAdded in Saleor 3.4.",
"fields": [
{
"name": "issuedAt",
"description": "Time of the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "DateTime",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "issuingPrincipal",
"description": "The user or application that triggered the event.",
"args": [],
"type": {
"kind": "UNION",
"name": "IssuingPrincipal",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "recipient",
"description": "The application receiving the webhook.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "App",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "version",
"description": "Saleor version that triggered the event.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "warehouse",
"description": "The warehouse the event relates to.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "Warehouse",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Event",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Webhook",
"description": "Webhook.",
"fields": [
{
"name": "app",
"description": "The app associated with Webhook.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "App",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "asyncEvents",
"description": "List of asynchronous webhook events.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookEventAsync",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customHeaders",
"description": "Custom headers, which will be added to HTTP request.\n\nAdded in Saleor 3.12.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "eventDeliveries",
"description": "Event deliveries.",
"args": [
{
"name": "after",
"description": "Return the elements in the list that come after the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "before",
"description": "Return the elements in the list that come before the specified cursor.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "filter",
"description": "Event delivery filter options.",
"type": {
"kind": "INPUT_OBJECT",
"name": "EventDeliveryFilterInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "first",
"description": "Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "last",
"description": "Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.",
"type": {
"kind": "SCALAR",
"name": "Int",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "sortBy",
"description": "Event delivery sorter.",
"type": {
"kind": "INPUT_OBJECT",
"name": "EventDeliverySortingInput",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "OBJECT",
"name": "EventDeliveryCountableConnection",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "List of webhook events.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookEvent",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead."
},
{
"name": "id",
"description": "The ID of webhook.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Informs if webhook is activated.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of webhook.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "secretKey",
"description": "Used to create a hash signature for each payload.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS."
},
{
"name": "subscriptionQuery",
"description": "Used to define payloads for specific events.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "syncEvents",
"description": "List of synchronous webhook events.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookEventSync",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetUrl",
"description": "Target URL for webhook.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [
{
"kind": "INTERFACE",
"name": "Node",
"ofType": null
}
],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookCreate",
"description": "Creates a new webhook subscription. \n\nRequires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhook",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Webhook",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "WebhookCreateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "app",
"description": "ID of the app to which webhook belongs.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "asyncEvents",
"description": "The asynchronous events that webhook wants to subscribe.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeAsyncEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customHeaders",
"description": "Custom headers, which will be added to HTTP request. There is a limitation of 5 headers per webhook and 998 characters per header.Only \"X-*\" and \"Authorization*\" keys are allowed.\n\nAdded in Saleor 3.12.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "The events that webhook wants to subscribe. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if webhook will be set active or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The name of the webhook.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "Subscription query used to define a webhook payload.\n\nAdded in Saleor 3.2.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "secretKey",
"description": "The secret key used to create a hash signature with each payload.\n\nDEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "syncEvents",
"description": "The synchronous events that webhook wants to subscribe.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeSyncEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetUrl",
"description": "The url to receive the payload.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookDelete",
"description": "Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. \n\nRequires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhook",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Webhook",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookDryRun",
"description": "Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookDryRunError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "payload",
"description": "JSON payload, that would be sent out to webhook's target URL.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookDryRunError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookDryRunErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WebhookDryRunErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_EVENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_SUBSCRIPTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SYNTAX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TYPE_NOT_SUPPORTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNABLE_TO_PARSE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WebhookErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "DELETE_FAILED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_CUSTOM_HEADERS",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_EVENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_SUBSCRIPTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "REQUIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SYNTAX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNABLE_TO_PARSE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNIQUE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookEvent",
"description": "Webhook event.",
"fields": [
{
"name": "eventType",
"description": "Internal name of the event type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Display name of the event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookEventAsync",
"description": "Asynchronous webhook event.",
"fields": [
{
"name": "eventType",
"description": "Internal name of the event type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeAsyncEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Display name of the event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookEventSync",
"description": "Synchronous webhook event.",
"fields": [
{
"name": "eventType",
"description": "Internal name of the event type.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeSyncEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "Display name of the event.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WebhookEventTypeAsyncEnum",
"description": "Enum determining type of webhook.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCOUNT_CHANGE_EMAIL_REQUESTED",
"description": "Account email change is requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_CONFIRMATION_REQUESTED",
"description": "An account confirmation is requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_CONFIRMED",
"description": "An account is confirmed.\n\nAdded in Saleor 3.15.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_DELETE_REQUESTED",
"description": "An account delete is requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_CREATED",
"description": "A new address created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_DELETED",
"description": "An address deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_UPDATED",
"description": "An address updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ANY_EVENTS",
"description": "All the events.\n\nDEPRECATED: this value will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_DELETED",
"description": "An app deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_INSTALLED",
"description": "A new app installed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_STATUS_CHANGED",
"description": "An app status is changed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_UPDATED",
"description": "An app updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_CREATED",
"description": "A new attribute is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_DELETED",
"description": "An attribute is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_UPDATED",
"description": "An attribute is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_CREATED",
"description": "A new attribute value is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_DELETED",
"description": "An attribute value is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_UPDATED",
"description": "An attribute value is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_CREATED",
"description": "A new category created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_DELETED",
"description": "A category is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_UPDATED",
"description": "A category is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_CREATED",
"description": "A new channel created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_DELETED",
"description": "A channel is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_METADATA_UPDATED",
"description": "A channel metadata is updated.\n\nAdded in Saleor 3.15.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_STATUS_CHANGED",
"description": "A channel status is changed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_UPDATED",
"description": "A channel is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_CREATED",
"description": "A new checkout is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_FULLY_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_METADATA_UPDATED",
"description": "A checkout metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_UPDATED",
"description": "A checkout is updated. It also triggers all updates related to the checkout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_CREATED",
"description": "A new collection is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_DELETED",
"description": "A collection is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_METADATA_UPDATED",
"description": "A collection metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_UPDATED",
"description": "A collection is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_CREATED",
"description": "A new customer account is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_DELETED",
"description": "A customer account is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_METADATA_UPDATED",
"description": "A customer account metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_UPDATED",
"description": "A customer account is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_CREATED",
"description": "A draft order is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_DELETED",
"description": "A draft order is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_UPDATED",
"description": "A draft order is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_APPROVED",
"description": "A fulfillment is approved.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CANCELED",
"description": "A fulfillment is cancelled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CREATED",
"description": "A new fulfillment is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_METADATA_UPDATED",
"description": "A fulfillment metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_CREATED",
"description": "A new gift card created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_DELETED",
"description": "A gift card is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_METADATA_UPDATED",
"description": "A gift card metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_SENT",
"description": "A gift card has been sent.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_STATUS_CHANGED",
"description": "A gift card status is changed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_UPDATED",
"description": "A gift card is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_DELETED",
"description": "An invoice is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_REQUESTED",
"description": "An invoice for order requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_SENT",
"description": "Invoice has been sent.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_CREATED",
"description": "A new menu created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_DELETED",
"description": "A menu is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_CREATED",
"description": "A new menu item created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_DELETED",
"description": "A menu item is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_UPDATED",
"description": "A menu item is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_UPDATED",
"description": "A menu is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTIFY_USER",
"description": "User notification triggered.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OBSERVABILITY",
"description": "An observability event is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_BULK_CREATED",
"description": "Orders are imported.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CANCELLED",
"description": "An order is cancelled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CONFIRMED",
"description": "An order is confirmed (status change unconfirmed -> unfulfilled) by a staff user using the OrderConfirm mutation. It also triggers when the user completes the checkout and the shop setting `automatically_confirm_all_new_orders` is enabled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CREATED",
"description": "A new order is placed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_EXPIRED",
"description": "An order is expired.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULFILLED",
"description": "An order is fulfilled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULLY_PAID",
"description": "Payment is made and an order is fully paid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULLY_REFUNDED",
"description": "The order is fully refunded.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_METADATA_UPDATED",
"description": "An order metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_PAID",
"description": "Payment has been made. The order may be partially or fully paid.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_REFUNDED",
"description": "The order received a refund. The order may be partially or fully refunded.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_UPDATED",
"description": "An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_CREATED",
"description": "A new page is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_DELETED",
"description": "A page is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_CREATED",
"description": "A new page type is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_DELETED",
"description": "A page type is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_UPDATED",
"description": "A page type is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_UPDATED",
"description": "A page is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_CREATED",
"description": "A new permission group is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_DELETED",
"description": "A permission group is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_UPDATED",
"description": "A permission group is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_CREATED",
"description": "A new product is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_DELETED",
"description": "A product is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_CREATED",
"description": "A new product media is created.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_DELETED",
"description": "A product media is deleted.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_UPDATED",
"description": "A product media is updated.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_METADATA_UPDATED",
"description": "A product metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_UPDATED",
"description": "A product is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_BACK_IN_STOCK",
"description": "A product variant is back in stock.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_CREATED",
"description": "A new product variant is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_DELETED",
"description": "A product variant is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_METADATA_UPDATED",
"description": "A product variant metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_OUT_OF_STOCK",
"description": "A product variant is out of stock.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_STOCK_UPDATED",
"description": "A product variant stock is updated",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_UPDATED",
"description": "A product variant is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_CREATED",
"description": "A sale is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_DELETED",
"description": "A sale is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_TOGGLE",
"description": "A sale is activated or deactivated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_UPDATED",
"description": "A sale is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_CREATED",
"description": "A new shipping price is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_DELETED",
"description": "A shipping price is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_UPDATED",
"description": "A shipping price is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_CREATED",
"description": "A new shipping zone is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_DELETED",
"description": "A shipping zone is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_METADATA_UPDATED",
"description": "A shipping zone metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_UPDATED",
"description": "A shipping zone is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHOP_METADATA_UPDATED",
"description": "Shop metadata is updated.\n\nAdded in Saleor 3.15.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_CREATED",
"description": "A new staff user is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_DELETED",
"description": "A staff user is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_UPDATED",
"description": "A staff user is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "THUMBNAIL_CREATED",
"description": "A thumbnail is created.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_ITEM_METADATA_UPDATED",
"description": "Transaction item metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSLATION_CREATED",
"description": "A new translation is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSLATION_UPDATED",
"description": "A translation is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_CREATED",
"description": "A new voucher created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_DELETED",
"description": "A voucher is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_METADATA_UPDATED",
"description": "A voucher metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_UPDATED",
"description": "A voucher is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_CREATED",
"description": "A new warehouse created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_DELETED",
"description": "A warehouse is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_METADATA_UPDATED",
"description": "A warehouse metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_UPDATED",
"description": "A warehouse is updated.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WebhookEventTypeEnum",
"description": "Enum determining type of webhook.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCOUNT_CHANGE_EMAIL_REQUESTED",
"description": "Account email change is requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_CONFIRMATION_REQUESTED",
"description": "An account confirmation is requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_CONFIRMED",
"description": "An account is confirmed.\n\nAdded in Saleor 3.15.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_DELETE_REQUESTED",
"description": "An account delete is requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_CREATED",
"description": "A new address created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_DELETED",
"description": "An address deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_UPDATED",
"description": "An address updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ANY_EVENTS",
"description": "All the events.\n\nDEPRECATED: this value will be removed in Saleor 4.0.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_DELETED",
"description": "An app deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_INSTALLED",
"description": "A new app installed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_STATUS_CHANGED",
"description": "An app status is changed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_UPDATED",
"description": "An app updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_CREATED",
"description": "A new attribute is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_DELETED",
"description": "An attribute is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_UPDATED",
"description": "An attribute is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_CREATED",
"description": "A new attribute value is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_DELETED",
"description": "An attribute value is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_UPDATED",
"description": "An attribute value is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_CREATED",
"description": "A new category created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_DELETED",
"description": "A category is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_UPDATED",
"description": "A category is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_CREATED",
"description": "A new channel created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_DELETED",
"description": "A channel is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_METADATA_UPDATED",
"description": "A channel metadata is updated.\n\nAdded in Saleor 3.15.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_STATUS_CHANGED",
"description": "A channel status is changed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_UPDATED",
"description": "A channel is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_CALCULATE_TAXES",
"description": "Event called for checkout tax calculation.\n\nAdded in Saleor 3.6.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_CREATED",
"description": "A new checkout is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_FILTER_SHIPPING_METHODS",
"description": "Filter shipping methods for checkout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_FULLY_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_METADATA_UPDATED",
"description": "A checkout metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_UPDATED",
"description": "A checkout is updated. It also triggers all updates related to the checkout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_CREATED",
"description": "A new collection is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_DELETED",
"description": "A collection is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_METADATA_UPDATED",
"description": "A collection metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_UPDATED",
"description": "A collection is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_CREATED",
"description": "A new customer account is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_DELETED",
"description": "A customer account is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_METADATA_UPDATED",
"description": "A customer account metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_UPDATED",
"description": "A customer account is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_CREATED",
"description": "A draft order is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_DELETED",
"description": "A draft order is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_UPDATED",
"description": "A draft order is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_APPROVED",
"description": "A fulfillment is approved.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CANCELED",
"description": "A fulfillment is cancelled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CREATED",
"description": "A new fulfillment is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_METADATA_UPDATED",
"description": "A fulfillment metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_CREATED",
"description": "A new gift card created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_DELETED",
"description": "A gift card is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_METADATA_UPDATED",
"description": "A gift card metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_SENT",
"description": "A gift card has been sent.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_STATUS_CHANGED",
"description": "A gift card status is changed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_UPDATED",
"description": "A gift card is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_DELETED",
"description": "An invoice is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_REQUESTED",
"description": "An invoice for order requested.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_SENT",
"description": "Invoice has been sent.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_CREATED",
"description": "A new menu created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_DELETED",
"description": "A menu is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_CREATED",
"description": "A new menu item created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_DELETED",
"description": "A menu item is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_UPDATED",
"description": "A menu item is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_UPDATED",
"description": "A menu is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTIFY_USER",
"description": "User notification triggered.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OBSERVABILITY",
"description": "An observability event is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_BULK_CREATED",
"description": "Orders are imported.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CALCULATE_TAXES",
"description": "Event called for order tax calculation.\n\nAdded in Saleor 3.6.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CANCELLED",
"description": "An order is cancelled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CONFIRMED",
"description": "An order is confirmed (status change unconfirmed -> unfulfilled) by a staff user using the OrderConfirm mutation. It also triggers when the user completes the checkout and the shop setting `automatically_confirm_all_new_orders` is enabled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CREATED",
"description": "A new order is placed.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_EXPIRED",
"description": "An order is expired.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FILTER_SHIPPING_METHODS",
"description": "Filter shipping methods for order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULFILLED",
"description": "An order is fulfilled.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULLY_PAID",
"description": "Payment is made and an order is fully paid.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULLY_REFUNDED",
"description": "The order is fully refunded.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_METADATA_UPDATED",
"description": "An order metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_PAID",
"description": "Payment has been made. The order may be partially or fully paid.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_REFUNDED",
"description": "The order received a refund. The order may be partially or fully refunded.\n\nAdded in Saleor 3.14.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_UPDATED",
"description": "An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_CREATED",
"description": "A new page is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_DELETED",
"description": "A page is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_CREATED",
"description": "A new page type is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_DELETED",
"description": "A page type is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_UPDATED",
"description": "A page type is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_UPDATED",
"description": "A page is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_AUTHORIZE",
"description": "Authorize payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_CAPTURE",
"description": "Capture payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_CONFIRM",
"description": "Confirm payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_GATEWAY_INITIALIZE_SESSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_LIST_GATEWAYS",
"description": "Listing available payment gateways.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_PROCESS",
"description": "Process payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_REFUND",
"description": "Refund payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_VOID",
"description": "Void payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_CREATED",
"description": "A new permission group is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_DELETED",
"description": "A permission group is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_UPDATED",
"description": "A permission group is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_CREATED",
"description": "A new product is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_DELETED",
"description": "A product is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_CREATED",
"description": "A new product media is created.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_DELETED",
"description": "A product media is deleted.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_UPDATED",
"description": "A product media is updated.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_METADATA_UPDATED",
"description": "A product metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_UPDATED",
"description": "A product is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_BACK_IN_STOCK",
"description": "A product variant is back in stock.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_CREATED",
"description": "A new product variant is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_DELETED",
"description": "A product variant is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_METADATA_UPDATED",
"description": "A product variant metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_OUT_OF_STOCK",
"description": "A product variant is out of stock.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_STOCK_UPDATED",
"description": "A product variant stock is updated",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_UPDATED",
"description": "A product variant is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_CREATED",
"description": "A sale is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_DELETED",
"description": "A sale is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_TOGGLE",
"description": "A sale is activated or deactivated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_UPDATED",
"description": "A sale is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_LIST_METHODS_FOR_CHECKOUT",
"description": "Fetch external shipping methods for checkout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_CREATED",
"description": "A new shipping price is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_DELETED",
"description": "A shipping price is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_UPDATED",
"description": "A shipping price is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_CREATED",
"description": "A new shipping zone is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_DELETED",
"description": "A shipping zone is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_METADATA_UPDATED",
"description": "A shipping zone metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_UPDATED",
"description": "A shipping zone is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHOP_METADATA_UPDATED",
"description": "Shop metadata is updated.\n\nAdded in Saleor 3.15.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_CREATED",
"description": "A new staff user is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_DELETED",
"description": "A staff user is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_UPDATED",
"description": "A staff user is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "THUMBNAIL_CREATED",
"description": "A thumbnail is created.\n\nAdded in Saleor 3.12.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_CANCELATION_REQUESTED",
"description": "Event called when cancel has been requested for transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_CHARGE_REQUESTED",
"description": "Event called when charge has been requested for transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_INITIALIZE_SESSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_ITEM_METADATA_UPDATED",
"description": "Transaction item metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_PROCESS_SESSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_REFUND_REQUESTED",
"description": "Event called when refund has been requested for transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSLATION_CREATED",
"description": "A new translation is created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSLATION_UPDATED",
"description": "A translation is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_CREATED",
"description": "A new voucher created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_DELETED",
"description": "A voucher is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_METADATA_UPDATED",
"description": "A voucher metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_UPDATED",
"description": "A voucher is updated.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_CREATED",
"description": "A new warehouse created.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_DELETED",
"description": "A warehouse is deleted.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_METADATA_UPDATED",
"description": "A warehouse metadata is updated.\n\nAdded in Saleor 3.8.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_UPDATED",
"description": "A warehouse is updated.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WebhookEventTypeSyncEnum",
"description": "Enum determining type of webhook.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "CHECKOUT_CALCULATE_TAXES",
"description": "Event called for checkout tax calculation.\n\nAdded in Saleor 3.6.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_FILTER_SHIPPING_METHODS",
"description": "Filter shipping methods for checkout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CALCULATE_TAXES",
"description": "Event called for order tax calculation.\n\nAdded in Saleor 3.6.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FILTER_SHIPPING_METHODS",
"description": "Filter shipping methods for order.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_AUTHORIZE",
"description": "Authorize payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_CAPTURE",
"description": "Capture payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_CONFIRM",
"description": "Confirm payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_GATEWAY_INITIALIZE_SESSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_LIST_GATEWAYS",
"description": "Listing available payment gateways.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_PROCESS",
"description": "Process payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_REFUND",
"description": "Refund payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAYMENT_VOID",
"description": "Void payment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_LIST_METHODS_FOR_CHECKOUT",
"description": "Fetch external shipping methods for checkout.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_CANCELATION_REQUESTED",
"description": "Event called when cancel has been requested for transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_CHARGE_REQUESTED",
"description": "Event called when charge has been requested for transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_INITIALIZE_SESSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_PROCESS_SESSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_REFUND_REQUESTED",
"description": "Event called when refund has been requested for transaction.\n\nAdded in Saleor 3.13.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WebhookSampleEventTypeEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "ACCOUNT_CHANGE_EMAIL_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_CONFIRMATION_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_CONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ACCOUNT_DELETE_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ADDRESS_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_INSTALLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_STATUS_CHANGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "APP_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ATTRIBUTE_VALUE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CATEGORY_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_STATUS_CHANGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHANNEL_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_FULLY_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CHECKOUT_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "COLLECTION_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "CUSTOMER_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "DRAFT_ORDER_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_APPROVED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CANCELED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FULFILLMENT_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_SENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_STATUS_CHANGED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "GIFT_CARD_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_REQUESTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVOICE_SENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_ITEM_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MENU_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOTIFY_USER",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OBSERVABILITY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_BULK_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CANCELLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CONFIRMED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_EXPIRED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULFILLED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULLY_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_FULLY_REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_PAID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_REFUNDED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ORDER_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_TYPE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PAGE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PERMISSION_GROUP_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_MEDIA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_BACK_IN_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_OUT_OF_STOCK",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_STOCK_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "PRODUCT_VARIANT_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_TOGGLE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SALE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_PRICE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHIPPING_ZONE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SHOP_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "STAFF_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "THUMBNAIL_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSACTION_ITEM_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSLATION_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TRANSLATION_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VOUCHER_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_CREATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_DELETED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_METADATA_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "WAREHOUSE_UPDATED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookTrigger",
"description": "Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload.\n\nAdded in Saleor 3.11.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point. \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER.",
"fields": [
{
"name": "delivery",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "EventDelivery",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookTriggerError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookTriggerError",
"description": null,
"fields": [
{
"name": "code",
"description": "The error code.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookTriggerErrorCode",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "field",
"description": "Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "message",
"description": "The error message.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WebhookTriggerErrorCode",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "GRAPHQL_ERROR",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INVALID_ID",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_EVENT",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_PERMISSION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_QUERY",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MISSING_SUBSCRIPTION",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NOT_FOUND",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SYNTAX",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TYPE_NOT_SUPPORTED",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNABLE_TO_PARSE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "WebhookUpdate",
"description": "Updates a webhook subscription. \n\nRequires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.",
"fields": [
{
"name": "errors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookError",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhook",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "Webhook",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "webhookErrors",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "WebhookError",
"ofType": null
}
}
}
},
"isDeprecated": true,
"deprecationReason": "This field will be removed in Saleor 4.0. Use `errors` field instead."
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INPUT_OBJECT",
"name": "WebhookUpdateInput",
"description": null,
"fields": null,
"inputFields": [
{
"name": "app",
"description": "ID of the app to which webhook belongs.",
"type": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "asyncEvents",
"description": "The asynchronous events that webhook wants to subscribe.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeAsyncEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "customHeaders",
"description": "Custom headers, which will be added to HTTP request. There is a limitation of 5 headers per webhook and 998 characters per header.Only \"X-*\" and \"Authorization*\" keys are allowed.\n\nAdded in Saleor 3.12.\n\nNote: this API is currently in Feature Preview and can be subject to changes at later point.",
"type": {
"kind": "SCALAR",
"name": "JSONString",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "events",
"description": "The events that webhook wants to subscribe. \n\nDEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isActive",
"description": "Determine if webhook will be set active or not.",
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": "The new name of the webhook.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "query",
"description": "Subscription query used to define a webhook payload.\n\nAdded in Saleor 3.2.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "secretKey",
"description": "Use to create a hash signature with each payload.\n\nDEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "syncEvents",
"description": "The synchronous events that webhook wants to subscribe.",
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeSyncEnum",
"ofType": null
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "targetUrl",
"description": "The url to receive the payload.",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "Weight",
"description": "Represents weight value in a specific weight unit.",
"fields": [
{
"name": "unit",
"description": "Weight unit.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WeightUnitsEnum",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "value",
"description": "Weight value.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Float",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "WeightScalar",
"description": null,
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "WeightUnitsEnum",
"description": "An enumeration.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "G",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "KG",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LB",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OZ",
"description": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "TONNE",
"description": null,
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "_Any",
"description": "_Any value scalar as defined by Federation spec.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "UNION",
"name": "_Entity",
"description": "_Entity union as defined by Federation spec.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Address",
"ofType": null
},
{
"kind": "OBJECT",
"name": "App",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Category",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Collection",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Group",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Order",
"ofType": null
},
{
"kind": "OBJECT",
"name": "PageType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Product",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductMedia",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductType",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ProductVariant",
"ofType": null
},
{
"kind": "OBJECT",
"name": "User",
"ofType": null
}
]
},
{
"kind": "OBJECT",
"name": "_Service",
"description": "_Service manifest as defined by Federation spec.",
"fields": [
{
"name": "sdl",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "__Directive",
"description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.",
"fields": [
{
"name": "name",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isRepeatable",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "locations",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "__DirectiveLocation",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "args",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__InputValue",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "__DirectiveLocation",
"description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "QUERY",
"description": "Location adjacent to a query operation.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "MUTATION",
"description": "Location adjacent to a mutation operation.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SUBSCRIPTION",
"description": "Location adjacent to a subscription operation.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FIELD",
"description": "Location adjacent to a field.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FRAGMENT_DEFINITION",
"description": "Location adjacent to a fragment definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FRAGMENT_SPREAD",
"description": "Location adjacent to a fragment spread.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INLINE_FRAGMENT",
"description": "Location adjacent to an inline fragment.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "VARIABLE_DEFINITION",
"description": "Location adjacent to a variable definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SCHEMA",
"description": "Location adjacent to a schema definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "SCALAR",
"description": "Location adjacent to a scalar definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OBJECT",
"description": "Location adjacent to an object type definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "FIELD_DEFINITION",
"description": "Location adjacent to a field definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ARGUMENT_DEFINITION",
"description": "Location adjacent to an argument definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INTERFACE",
"description": "Location adjacent to an interface definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNION",
"description": "Location adjacent to a union definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENUM",
"description": "Location adjacent to an enum definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENUM_VALUE",
"description": "Location adjacent to an enum value definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INPUT_OBJECT",
"description": "Location adjacent to an input object type definition.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INPUT_FIELD_DEFINITION",
"description": "Location adjacent to an input object field definition.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "__EnumValue",
"description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.",
"fields": [
{
"name": "name",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isDeprecated",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deprecationReason",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "__Field",
"description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.",
"fields": [
{
"name": "name",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "args",
"description": null,
"args": [
{
"name": "includeDeprecated",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__InputValue",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isDeprecated",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deprecationReason",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "__InputValue",
"description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.",
"fields": [
{
"name": "name",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "type",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "defaultValue",
"description": "A GraphQL-formatted string representing the default value for this input value.",
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "isDeprecated",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "deprecationReason",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "__Schema",
"description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.",
"fields": [
{
"name": "description",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "types",
"description": "A list of all types supported by this server.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "queryType",
"description": "The type that query operations will be rooted at.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "mutationType",
"description": "If this server supports mutation, the type that mutation operations will be rooted at.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "subscriptionType",
"description": "If this server support subscription, the type that subscription operations will be rooted at.",
"args": [],
"type": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "directives",
"description": "A list of all directives supported by this server.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Directive",
"ofType": null
}
}
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "OBJECT",
"name": "__Type",
"description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name, description and optional `specifiedByUrl`, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.",
"fields": [
{
"name": "kind",
"description": null,
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "__TypeKind",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "name",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "description",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "specifiedByUrl",
"description": null,
"args": [],
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "fields",
"description": null,
"args": [
{
"name": "includeDeprecated",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Field",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "interfaces",
"description": null,
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "possibleTypes",
"description": null,
"args": [],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "enumValues",
"description": null,
"args": [
{
"name": "includeDeprecated",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__EnumValue",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "inputFields",
"description": null,
"args": [
{
"name": "includeDeprecated",
"description": null,
"type": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
},
"defaultValue": "false",
"isDeprecated": false,
"deprecationReason": null
}
],
"type": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "OBJECT",
"name": "__InputValue",
"ofType": null
}
}
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ofType",
"description": null,
"args": [],
"type": {
"kind": "OBJECT",
"name": "__Type",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "ENUM",
"name": "__TypeKind",
"description": "An enum describing what kind of type a given `__Type` is.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": [
{
"name": "SCALAR",
"description": "Indicates this type is a scalar.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "OBJECT",
"description": "Indicates this type is an object. `fields` and `interfaces` are valid fields.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INTERFACE",
"description": "Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes` are valid fields.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "UNION",
"description": "Indicates this type is a union. `possibleTypes` is a valid field.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "ENUM",
"description": "Indicates this type is an enum. `enumValues` is a valid field.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "INPUT_OBJECT",
"description": "Indicates this type is an input object. `inputFields` is a valid field.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "LIST",
"description": "Indicates this type is a list. `ofType` is a valid field.",
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "NON_NULL",
"description": "Indicates this type is a non-null. `ofType` is a valid field.",
"isDeprecated": false,
"deprecationReason": null
}
],
"possibleTypes": null
}
],
"directives": [
{
"name": "deprecated",
"description": "Marks an element of a GraphQL schema as no longer supported.",
"isRepeatable": false,
"locations": ["ENUM_VALUE", "FIELD_DEFINITION"],
"args": [
{
"name": "reason",
"description": "Explains why this element was deprecated, usually also including a suggestion for how toaccess supported similar data. Formatted in [Markdown](https://daringfireball.net/projects/markdown/).",
"type": {
"kind": "SCALAR",
"name": "String",
"ofType": null
},
"defaultValue": "\"No longer supported\"",
"isDeprecated": false,
"deprecationReason": null
}
]
},
{
"name": "doc",
"description": "Groups fields and operations into named groups.",
"isRepeatable": false,
"locations": [
"ENUM",
"FIELD",
"FIELD_DEFINITION",
"INPUT_OBJECT",
"OBJECT"
],
"args": [
{
"name": "category",
"description": "Name of the grouping category",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "String",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
]
},
{
"name": "include",
"description": "Directs the executor to include this field or fragment only when the `if` argument is true.",
"isRepeatable": false,
"locations": ["FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"],
"args": [
{
"name": "if",
"description": "Included when true.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
]
},
{
"name": "skip",
"description": "Directs the executor to skip this field or fragment when the `if` argument is true.",
"isRepeatable": false,
"locations": ["FIELD", "FRAGMENT_SPREAD", "INLINE_FRAGMENT"],
"args": [
{
"name": "if",
"description": "Skipped when true.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
]
},
{
"name": "webhookEventsInfo",
"description": "Webhook events triggered by a specific location.",
"isRepeatable": false,
"locations": ["FIELD", "FIELD_DEFINITION", "INPUT_OBJECT", "OBJECT"],
"args": [
{
"name": "asyncEvents",
"description": "List of asynchronous webhook events triggered by a specific location.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeAsyncEnum",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "syncEvents",
"description": "List of synchronous webhook events triggered by a specific location.",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "LIST",
"name": null,
"ofType": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "ENUM",
"name": "WebhookEventTypeSyncEnum",
"ofType": null
}
}
}
},
"defaultValue": null,
"isDeprecated": false,
"deprecationReason": null
}
]
}
]
}
}
Reference in a new issue View git blame Copy permalink