saleor-dashboard/schema.graphql
Michał Droń 5c1a62171d
🦄 Simple taxes (#2072)
* Tax configuration - implement channels view (#2048)

* Add channels view

* Fix channels view import

* Remove legacy stories references

* Fix link in configuration

* Update snapshots

* Remove sample checkboxes props

* Disable hover in country exceptions

* Update snapshots

* Extract country exception rows to seperate component

* Extract components to seperate files

* Remove duplicated section name

* Remove backlink

* Add translations to section names

* Extract messages

* Add ListItemLink component

* Replace navigator with link in TaxChannelsMenu

* Fix horizontal scroll in TaxChannelsMenu

* Change codegen to build from custom schema

* Build types

* Update fragments

* Add fixtures

* Change any to proper types

* Add story for tax channels page

* Replace MUI Skeleton with Saleor Skeleton

* Change clsx import to classnames

* Fix checkboxes shadows in settings card

* Update IDs in fixtures

* Fix offset in TaxChannelsMenu

* Update snapshots

* Remove any from TaxSettings

* Fix todos

* Change relative marginLeft to before pseudoelement

* Extract styles to seperate files

* Change folder structure

* Extract redirect logic to custom hook

* Update snapshots

* Fix comment

* Add early return in channels view

* Tax configuration - implement countries view (#2053)

* Add channels view

* Remove sample checkboxes props

* Disable hover in country exceptions

* Extract country exception rows to seperate component

* Extract components to seperate files

* Remove duplicated section name

* Remove backlink

* Add translations to section names

* Replace navigator with link in TaxChannelsMenu

* Fix horizontal scroll in TaxChannelsMenu

* Change any to proper types

* Add story for tax channels page

* Replace MUI Skeleton with Saleor Skeleton

* Change clsx import to classnames

* Fix checkboxes shadows in settings card

* Update IDs in fixtures

* Fix offset in TaxChannelsMenu

* Remove any from TaxSettings

* Add countries list view

* Add TaxCountryMenu component

* Add CountryList page

* Change channels menu rows height

* Change countries menu rows height

* Add TaxInput component

* Add tax classes rates to countries page

* Fix search input padding

* Add minmax to TaxInput

* Add searching through tax class rates

* Extract messages

* Add better handlers

* Add fullWidth to TaxInput

* Specify type for TaxInputs

* Remove spinboxes on firefox

* Remove custom spinboxes

* Remove maxHeight from menu rows

* Post-rebase fix

* Change setter to formchagne

* Add TaxConfiguration fragment

* Add isDefault field to taxClass

* Add fixtures

* Shape data

* Replace useEffect with useTaxUrlRedirect

* Fix country names in menu

* Add country page story

* Add early return in countries view

* Unify loading states between channels and countries pages

* Handle special chars and case insensitiveness in local search

* Replace navigate function with ListItemLink

* Move styles to seperate file

* Move styles to seperate file

* Migrate to strict null checks

* Remove unnecessary optional chaining

* Change overflow scroll to Y only

* Add useMemo on finding selected country

* Add useMemo on local search

* Translate labels in page tabs

* Change url from /taxes/classes to /taxes/tax-classes

* Remove capitalization from strings

* Extract messages

* Bump macaw to 0.6.2

* Update snapshots

* Add spinboxes explanation comment

* Handle empty state

* Add tax classes view (#2093)

* Add TaxClass fragment

* Build types

* Add tax classes to fixtures

* Add tax classes view

* wip Add tax classes page

* Add tax classes menu

* Add TaxRate fragment

* Extract logic

* Handle loading state & add story

* Extract messages

* Update snapshots

* Change schema building from schema back to introspection

* Update schema

* Update fragments

* Build types

* Update fixtures

* Reshape data

* Move styles to seperate file

* Use getById

* Add explicit undefined

* Comment out unfinished modal stories

* Update snapshots

* Taxes - add API calls in channels view (#2106)

* Build types

* Add TaxRate fragment

* Update snapshots

* Add taxConfigurationList query

* Add taxCountriesList query

* Add TaxClassesList query

* Rename TaxConfigurationsList query

* Handle empty state

* Fix types post-rebase

* Add form to TaxChannelsPage

* wip Add dialog for handling country exceptions

* wip Fix dialog url

* wip Add update exceptions handlers

* Add dialog story

* Fix type errors

* Add mutation support

* Fix types in story

* Add transition state to submit button

* Add notifier

* Extract messages

* Remove unused import

* Add backlink in savebar

* Update snapshots

* Fix link in navigation

* Update snapshots

* Remove message from tax config error fragment

* Add hook description

* Use useStateFromProps

* Remove error handling

* Improve url & path function names

* Use theme.spacing in TaxCountryDialog styles

* Remove redundant key modification

* Revert "Use useStateFromProps"

This reverts commit d3c68b04701cf935e917d7baa3ed1361ca3446d5.

* Move initial map to parent & add open dependency to countries state

* Use useModalDialogOpen

* Fix state update

* Remove scrolls & add ellipsis in side menu

* Center checkboxes

* Update snapshots

* Add fake div for list alignment

* Trigger deployment

* Close modal on submit

* Remove divider on last ListItem

* Align add country button

* Wrap grid child in div to avoid card stretching

* Update snapshots

* Trigger changes in add/delete exceptions

* Trigger change on expcetion checkboxes

* Add trailing commas

* Connect countries view to API (#2178)

* Add empty states

* Update countries view urls

* Remove unused import

* Add country modal to countries view

* Update schema

* Implement country view mutations & error fragments

* Implement tax class update mutation

* Add sidebar temporary state for new configs

* Remove unused imports

* Wrap in form

* Add savebar & fix search

* Update schema

* Add form wrapper

* Fix types

* Extract messages

* Bump macaw

* Update snapshots

* Fix comma dangles

* Update snapshots

* Notify about mutation success

* Add logic for mixing current and new rates

* Workaround for sending null rates

* Fix filling form with correct data after submitting

* Handle deleting configuration

* Fix selected banner

* Remove leftover comment

* Add handler for country configuration delete

* Trigger deployment

* Clean up useEffects causing infinite render loops

* Sort countries from api by name

* Fix card bottom padding

* Remove bottom divider & fix padding

* Remove scroll wrapper in side menu

* Update snapshots

* Remove scroll wrapper from tax classes menu

* Update snapshots

* Refresh form to initial onSubmit

* Revert "Refresh form to initial onSubmit"

This reverts commit 42414237d35086da63f4aa088c8072411429b1d8.

* Allow only 3 decimal characters in tax inputs

* Update snapshots

* Update schema

* Update types

* Change logic from default tax class to null class

* Fix sorting

* Send empty country rates as nulls in mutation

* Extract messages

* Update lockfile

* Update schema

* Drop default tax classes

* Update snapshots

* Post-rebase fixes

* Connect tax classes view to API (#2334)

* Add mutations

* Handle empty state

* Wrap page in form

* Update stories

* Build types

* Handle tax class delete

* Handle update tax class

* Update stories

* Handle tax class change name

* Add mutation state to savebar

* Handle creating new tax classes

* Extract messages

* Specify type

* Update stories

* Sort rates

* Fix skeleton rendering

* Remove placeholders

* Fix skeleton rendering on country list

* Update snapshots

* Change initial pagination to 100

* Disallow creating multiple new tax classes

* Disallow creating multiple country configurations

* Fix messages

* Autofocus on new tax class name

* Add country name to header

* Temporarily comment out broken code in tax channels

* Update snapshots

* Update snapshots post-rebase

* Add tax strategies & assigning tax classes (#2369)

* Update fragments

* Add optional merging in useForm

* Handle tax strategies

* Update snapshots

* Update fixtures

* Extract messages

* Remove unused shop query fields

* Fix breaking bug when fetchMore is used in non-searchable SingleAutocompleteSelectFields

* Migrate product types to tax classes

* Add tax classes to shipping methods

* Use encapsulated logic in product types

* Fix product type stories

* Fix shipping fixtures

* Fix product type type mismatch

* Fix shipping stories

* Fix product type fixtures

* Fix mismatching types

* Extract messages

* Update snapshots

* Update snapshots

* Fix comment

* Drop deprecated graphql fields

* Replace tax types with tax classes in product create view

* Replace tax types with tax classes in product update view

* Fix tests, stories, fixtures

* Extract messages

* Update snapshots

* Move status messages to commonStatusMessages

* Handle empty array case in tax class change handler

* Reuse messages

* Simple taxes bugfixes (#2395)

* Fix tax channels menu - dense layout

* Change view names to fit convention

* Fix per country exceptions in tax channels view

* Fix skeleton rendering on tax countries card title

* Filter out existing countries from modal

* Update snapshots

* Fix deleting country configuration

* Disallow negative values in tax inputs

* Handle empty tax classes view

* Allow empty options in shipping & product types views tax class assignment field

* Modify undefined rates in tax classes view

* Update macaw-ui

* Fix UI on channels view

* Fix UI on countries view

* Fix UI on countries view

* Align tax class rate label to the right

* Updaste snapshots

* Extract messages

* Fix adding rates on new tax class

* Fix key errors

* Update schema

* Build types

* Allow empty rates in taxClassUpdate mutation

* Extract tax channels change country function as a handler

* Deprecate useStateFromProps

* Change useStateFromProps to useStateUpdate

* Fix dividers

* Delete delete icon on new tax classes

* Update snapshots

* Update lockfile

* Update macaw to 0.6.6

* Update snapshots

* Specify type of input in country change handler

* Extract autofocus logic to custom hook

* Replace alternative with switch statement

* Extract country exclusion logic from JSX

* Update lockfile

* Update lockfile

* Trigger deployment

* Fix invisible select markers

* Fix linter issue

* Fix crashing product details page

* Fix e2e error

* Update snapshots

* Allow view taxes with any staff permissions (#2510)

* Update after rebase

Co-authored-by: Dawid <tarasiukdawid@gmail.com>
2022-11-17 13:48:50 +01:00

26381 lines
615 KiB
GraphQL
Raw Blame History

This file contains ambiguous Unicode characters

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

"""
Create a new address for the customer.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountAddressCreate {
"""A user instance for which the address was created."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
"""
type AccountAddressDelete {
"""A user instance for which the address was deleted."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
"""
type AccountAddressUpdate {
"""A user object for which the address was edited."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Remove user account.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountDelete {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
type AccountError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: AccountErrorCode!
"""A type of address that causes the error."""
addressType: AddressTypeEnum
}
"""An enumeration."""
enum AccountErrorCode {
ACTIVATE_OWN_ACCOUNT
ACTIVATE_SUPERUSER_ACCOUNT
DUPLICATED_INPUT_ITEM
DEACTIVATE_OWN_ACCOUNT
DEACTIVATE_SUPERUSER_ACCOUNT
DELETE_NON_STAFF_USER
DELETE_OWN_ACCOUNT
DELETE_STAFF_ACCOUNT
DELETE_SUPERUSER_ACCOUNT
GRAPHQL_ERROR
INACTIVE
INVALID
INVALID_PASSWORD
LEFT_NOT_MANAGEABLE_PERMISSION
INVALID_CREDENTIALS
NOT_FOUND
OUT_OF_SCOPE_USER
OUT_OF_SCOPE_GROUP
OUT_OF_SCOPE_PERMISSION
PASSWORD_ENTIRELY_NUMERIC
PASSWORD_TOO_COMMON
PASSWORD_TOO_SHORT
PASSWORD_TOO_SIMILAR
REQUIRED
UNIQUE
JWT_SIGNATURE_EXPIRED
JWT_INVALID_TOKEN
JWT_DECODE_ERROR
JWT_MISSING_TOKEN
JWT_INVALID_CSRF_TOKEN
CHANNEL_INACTIVE
MISSING_CHANNEL_SLUG
ACCOUNT_NOT_CONFIRMED
}
input AccountInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""User language code."""
languageCode: LanguageCodeEnum
"""Billing address of the customer."""
defaultBillingAddress: AddressInput
"""Shipping address of the customer."""
defaultShippingAddress: AddressInput
}
"""Register a new user."""
type AccountRegister {
"""Informs whether users need to confirm their email address."""
requiresConfirmation: Boolean
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
input AccountRegisterInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""User language code."""
languageCode: LanguageCodeEnum
"""The email address of the user."""
email: String!
"""Password."""
password: String!
"""Base of frontend URL that will be needed to create confirmation URL."""
redirectUrl: String
"""User public metadata."""
metadata: [MetadataInput!]
"""
Slug of a channel which will be used to notify users. Optional when only one channel exists.
"""
channel: String
}
"""
Sends an email with the account removal link for the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountRequestDeletion {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Sets a default address for the authenticated user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountSetDefaultAddress {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Updates the account of the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountUpdate {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""Represents user address data."""
type Address implements Node {
id: ID!
firstName: String!
lastName: String!
companyName: String!
streetAddress1: String!
streetAddress2: String!
city: String!
cityArea: String!
postalCode: String!
"""Shop's default country."""
country: CountryDisplay!
countryArea: String!
phone: String
"""Address is user's default shipping address."""
isDefaultShippingAddress: Boolean
"""Address is user's default billing address."""
isDefaultBillingAddress: Boolean
}
"""
Creates user address.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressCreate {
"""A user instance for which the address was created."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Event sent when new address is created.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AddressCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The address the event relates to."""
address: Address
}
"""
Deletes an address.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressDelete {
"""A user instance for which the address was deleted."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Event sent when address is deleted.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AddressDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The address the event relates to."""
address: Address
}
input AddressInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""Company or organization."""
companyName: String
"""Address."""
streetAddress1: String
"""Address."""
streetAddress2: String
"""City."""
city: String
"""District."""
cityArea: String
"""Postal code."""
postalCode: String
"""Country."""
country: CountryCode
"""State or province."""
countryArea: String
"""Phone number."""
phone: String
}
"""
Sets a default address for the given user.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressSetDefault {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""An enumeration."""
enum AddressTypeEnum {
BILLING
SHIPPING
}
"""
Updates an address.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressUpdate {
"""A user object for which the address was edited."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Event sent when address is updated.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AddressUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The address the event relates to."""
address: Address
}
type AddressValidationData {
countryCode: String!
countryName: String!
addressFormat: String!
addressLatinFormat: String!
allowedFields: [String!]!
requiredFields: [String!]!
upperFields: [String!]!
countryAreaType: String!
countryAreaChoices: [ChoiceValue!]!
cityType: String!
cityChoices: [ChoiceValue!]!
cityAreaType: String!
cityAreaChoices: [ChoiceValue!]!
postalCodeType: String!
postalCodeMatchers: [String!]!
postalCodeExamples: [String!]!
postalCodePrefix: String!
}
"""Represents allocation."""
type Allocation implements Node {
id: ID!
"""
Quantity allocated for orders.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
quantity: Int!
"""
The warehouse were items were allocated.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
warehouse: Warehouse!
}
"""
Determine the allocation strategy for the channel.
PRIORITIZE_SORTING_ORDER - allocate stocks according to the warehouses' order
within the channel
PRIORITIZE_HIGH_STOCK - allocate stock in a warehouse with the most stock
"""
enum AllocationStrategyEnum {
PRIORITIZE_SORTING_ORDER
PRIORITIZE_HIGH_STOCK
}
"""Represents app data."""
type App implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""List of the app's permissions."""
permissions: [Permission!]
"""The date and time when the app was created."""
created: DateTime
"""Determine if app will be set active or not."""
isActive: Boolean
"""Name of the app."""
name: String
"""Type of the app."""
type: AppTypeEnum
"""
Last 4 characters of the tokens.
Requires one of the following permissions: MANAGE_APPS, OWNER.
"""
tokens: [AppToken!]
"""
List of webhooks assigned to this app.
Requires one of the following permissions: MANAGE_APPS, OWNER.
"""
webhooks: [Webhook!]
"""Description of this app."""
aboutApp: String
"""Description of the data privacy defined for this app."""
dataPrivacy: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead.")
"""URL to details about the privacy policy on the app owner page."""
dataPrivacyUrl: String
"""Homepage of the app."""
homepageUrl: String
"""Support page for the app."""
supportUrl: String
"""URL to iframe with the configuration for the app."""
configurationUrl: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `appUrl` instead.")
"""URL to iframe with the app."""
appUrl: String
"""
URL to manifest used during app's installation.
Added in Saleor 3.5.
"""
manifestUrl: String
"""Version number of the app."""
version: String
"""JWT token used to authenticate by thridparty app."""
accessToken: String
"""
App's dashboard extensions.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
extensions: [AppExtension!]!
}
"""
Activate the app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppActivate {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
type AppCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AppCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type AppCountableEdge {
"""The item at the end of the edge."""
node: App!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
"""
type AppCreate {
"""The newly created authentication token."""
authToken: String
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
"""
Deactivate the app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppDeactivate {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
"""
Deletes an app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppDelete {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
"""
Delete failed installation.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppDeleteFailedInstallation {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
}
"""
Event sent when app is deleted.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AppDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The application the event relates to."""
app: App
}
type AppError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: AppErrorCode!
"""List of permissions which causes the error."""
permissions: [PermissionEnum!]
}
"""An enumeration."""
enum AppErrorCode {
FORBIDDEN
GRAPHQL_ERROR
INVALID
INVALID_STATUS
INVALID_PERMISSION
INVALID_URL_FORMAT
INVALID_MANIFEST_FORMAT
MANIFEST_URL_CANT_CONNECT
NOT_FOUND
REQUIRED
UNIQUE
OUT_OF_SCOPE_APP
OUT_OF_SCOPE_PERMISSION
}
"""Represents app data."""
type AppExtension implements Node {
id: ID!
"""List of the app extension's permissions."""
permissions: [Permission!]!
"""Label of the extension to show in the dashboard."""
label: String!
"""URL of a view where extension's iframe is placed."""
url: String!
"""Place where given extension will be mounted."""
mount: AppExtensionMountEnum!
"""Type of way how app extension will be opened."""
target: AppExtensionTargetEnum!
app: App!
"""JWT token used to authenticate by thridparty app extension."""
accessToken: String
}
type AppExtensionCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AppExtensionCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type AppExtensionCountableEdge {
"""The item at the end of the edge."""
node: AppExtension!
"""A cursor for use in pagination."""
cursor: String!
}
input AppExtensionFilterInput {
mount: [AppExtensionMountEnum!]
target: AppExtensionTargetEnum
}
"""All places where app extension can be mounted."""
enum AppExtensionMountEnum {
CUSTOMER_OVERVIEW_CREATE
CUSTOMER_OVERVIEW_MORE_ACTIONS
CUSTOMER_DETAILS_MORE_ACTIONS
PRODUCT_OVERVIEW_CREATE
PRODUCT_OVERVIEW_MORE_ACTIONS
PRODUCT_DETAILS_MORE_ACTIONS
NAVIGATION_CATALOG
NAVIGATION_ORDERS
NAVIGATION_CUSTOMERS
NAVIGATION_DISCOUNTS
NAVIGATION_TRANSLATIONS
NAVIGATION_PAGES
ORDER_DETAILS_MORE_ACTIONS
ORDER_OVERVIEW_CREATE
ORDER_OVERVIEW_MORE_ACTIONS
}
"""
All available ways of opening an app extension.
POPUP - app's extension will be mounted as a popup window
APP_PAGE - redirect to app's page
"""
enum AppExtensionTargetEnum {
POPUP
APP_PAGE
}
"""
Fetch and validate manifest.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppFetchManifest {
manifest: Manifest
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
}
input AppFilterInput {
search: String
isActive: Boolean
type: AppTypeEnum
}
input AppInput {
"""Name of the app."""
name: String
"""List of permission code names to assign to this app."""
permissions: [PermissionEnum!]
}
"""
Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
"""
type AppInstall {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
}
input AppInstallInput {
"""Name of the app to install."""
appName: String
"""Url to app's manifest in JSON format."""
manifestUrl: String
"""Determine if app will be set active or not."""
activateAfterInstallation: Boolean = true
"""List of permission code names to assign to this app."""
permissions: [PermissionEnum!]
}
"""Represents ongoing installation of app."""
type AppInstallation implements Node & Job {
id: ID!
"""Job status."""
status: JobStatusEnum!
"""Created date time of job in ISO 8601 format."""
createdAt: DateTime!
"""Date time of job last update in ISO 8601 format."""
updatedAt: DateTime!
"""Job message."""
message: String
appName: String!
manifestUrl: String!
}
"""
Event sent when new app is installed.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AppInstalled implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The application the event relates to."""
app: App
}
type AppManifestExtension {
"""List of the app extension's permissions."""
permissions: [Permission!]!
"""Label of the extension to show in the dashboard."""
label: String!
"""URL of a view where extension's iframe is placed."""
url: String!
"""Place where given extension will be mounted."""
mount: AppExtensionMountEnum!
"""Type of way how app extension will be opened."""
target: AppExtensionTargetEnum!
}
type AppManifestWebhook {
"""The name of the webhook."""
name: String!
"""The asynchronous events that webhook wants to subscribe."""
asyncEvents: [WebhookEventTypeAsyncEnum!]
"""The synchronous events that webhook wants to subscribe."""
syncEvents: [WebhookEventTypeSyncEnum!]
"""Subscription query of a webhook"""
query: String!
"""The url to receive the payload."""
targetUrl: String!
}
"""
Retry failed installation of new app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppRetryInstall {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
}
enum AppSortField {
"""Sort apps by name."""
NAME
"""Sort apps by creation date."""
CREATION_DATE
}
input AppSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort apps by the selected field."""
field: AppSortField!
}
"""
Event sent when app status has changed.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AppStatusChanged implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The application the event relates to."""
app: App
}
"""Represents token data."""
type AppToken implements Node {
id: ID!
"""Name of the authenticated token."""
name: String
"""Last 4 characters of the token."""
authToken: String
}
"""
Creates a new token.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppTokenCreate {
"""The newly created authentication token."""
authToken: String
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appToken: AppToken
}
"""
Deletes an authentication token assigned to app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppTokenDelete {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appToken: AppToken
}
input AppTokenInput {
"""Name of the token."""
name: String
"""ID of app."""
app: ID!
}
"""Verify provided app token."""
type AppTokenVerify {
"""Determine if token is valid or not."""
valid: Boolean!
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
}
"""Enum determining type of your App."""
enum AppTypeEnum {
"""
Local Saleor App. The app is fully manageable from dashboard. You can change assigned permissions, add webhooks, or authentication token
"""
LOCAL
"""
Third party external App. Installation is fully automated. Saleor uses a defined App manifest to gather all required information.
"""
THIRDPARTY
}
"""
Updates an existing app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppUpdate {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
"""
Event sent when app is updated.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AppUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The application the event relates to."""
app: App
}
"""An enumeration."""
enum AreaUnitsEnum {
SQ_CM
SQ_M
SQ_KM
SQ_FT
SQ_YD
SQ_INCH
}
"""
Assigns storefront's navigation menus.
Requires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS.
"""
type AssignNavigation {
"""Assigned navigation menu."""
menu: Menu
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
}
"""
Represents assigned attribute to variant with variant selection attached.
Added in Saleor 3.1.
"""
type AssignedVariantAttribute {
"""Attribute assigned to variant."""
attribute: Attribute!
"""
Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric']
"""
variantSelection: Boolean!
}
"""
Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.
"""
type Attribute implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""The input type to use for entering attribute values in the dashboard."""
inputType: AttributeInputTypeEnum
"""The entity type which can be used as a reference."""
entityType: AttributeEntityTypeEnum
"""Name of an attribute displayed in the interface."""
name: String
"""Internal representation of an attribute name."""
slug: String
"""The attribute type."""
type: AttributeTypeEnum
"""The unit of attribute values."""
unit: MeasurementUnitsEnum
"""List of attribute's values."""
choices(
"""Sort attribute choices."""
sortBy: AttributeChoicesSortingInput
"""Filtering options for attribute choices."""
filter: AttributeValueFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): AttributeValueCountableConnection
"""
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.
"""
valueRequired: Boolean!
"""
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.
"""
visibleInStorefront: Boolean!
"""
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.
"""
filterableInStorefront: Boolean!
"""
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.
"""
filterableInDashboard: Boolean!
"""
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.
"""
availableInGrid: Boolean!
"""
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.
"""
storefrontSearchPosition: Int!
"""Returns translated attribute fields for the given language code."""
translation(
"""A language code to return the translation for attribute."""
languageCode: LanguageCodeEnum!
): AttributeTranslation
"""Flag indicating that attribute has predefined choices."""
withChoices: Boolean!
productTypes(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductTypeCountableConnection!
productVariantTypes(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductTypeCountableConnection!
}
"""
Deletes attributes.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type AttributeBulkDelete {
"""Returns how many objects were affected."""
count: Int!
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
}
enum AttributeChoicesSortField {
"""Sort attribute choice by name."""
NAME
"""Sort attribute choice by slug."""
SLUG
}
input AttributeChoicesSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort attribute choices by the selected field."""
field: AttributeChoicesSortField!
}
type AttributeCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AttributeCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type AttributeCountableEdge {
"""The item at the end of the edge."""
node: Attribute!
"""A cursor for use in pagination."""
cursor: String!
}
"""Creates an attribute."""
type AttributeCreate {
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
}
input AttributeCreateInput {
"""The input type to use for entering attribute values in the dashboard."""
inputType: AttributeInputTypeEnum
"""The entity type which can be used as a reference."""
entityType: AttributeEntityTypeEnum
"""Name of an attribute displayed in the interface."""
name: String!
"""Internal representation of an attribute name."""
slug: String
"""The attribute type."""
type: AttributeTypeEnum!
"""The unit of attribute values."""
unit: MeasurementUnitsEnum
"""List of attribute's values."""
values: [AttributeValueCreateInput!]
"""Whether the attribute requires values to be passed or not."""
valueRequired: Boolean
"""Whether the attribute is for variants only."""
isVariantOnly: Boolean
"""Whether the attribute should be visible or not in storefront."""
visibleInStorefront: Boolean
"""Whether the attribute can be filtered in storefront."""
filterableInStorefront: Boolean
"""Whether the attribute can be filtered in dashboard."""
filterableInDashboard: Boolean
"""
The position of the attribute in the storefront navigation (0 by default).
"""
storefrontSearchPosition: Int
"""Whether the attribute can be displayed in the admin product list."""
availableInGrid: Boolean
}
"""
Event sent when new attribute is created.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AttributeCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The attribute the event relates to."""
attribute: Attribute
}
"""
Deletes an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type AttributeDelete {
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
attribute: Attribute
}
"""
Event sent when attribute is deleted.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AttributeDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The attribute the event relates to."""
attribute: Attribute
}
"""An enumeration."""
enum AttributeEntityTypeEnum {
PAGE
PRODUCT
PRODUCT_VARIANT
}
type AttributeError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: AttributeErrorCode!
}
"""An enumeration."""
enum AttributeErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input AttributeFilterInput {
valueRequired: Boolean
isVariantOnly: Boolean
visibleInStorefront: Boolean
filterableInStorefront: Boolean
filterableInDashboard: Boolean
availableInGrid: Boolean
metadata: [MetadataFilter!]
search: String
ids: [ID!]
type: AttributeTypeEnum
inCollection: ID
inCategory: ID
slugs: [String!]
"""
Specifies the channel by which the data should be filtered.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
}
input AttributeInput {
"""Internal representation of an attribute name."""
slug: String!
"""Internal representation of a value (unique per attribute)."""
values: [String!]
"""The range that the returned values should be in."""
valuesRange: IntRangeInput
"""The date/time range that the returned values should be in."""
dateTime: DateTimeRangeInput
"""
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.
"""
date: DateRangeInput
"""The boolean value of the attribute."""
boolean: Boolean
}
"""An enumeration."""
enum AttributeInputTypeEnum {
DROPDOWN
MULTISELECT
FILE
REFERENCE
NUMERIC
RICH_TEXT
PLAIN_TEXT
SWATCH
BOOLEAN
DATE
DATE_TIME
}
"""
Reorder the values of an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type AttributeReorderValues {
"""Attribute from which values are reordered."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
}
enum AttributeSortField {
"""Sort attributes by name"""
NAME
"""Sort attributes by slug"""
SLUG
"""Sort attributes by the value required flag"""
VALUE_REQUIRED
"""Sort attributes by the variant only flag"""
IS_VARIANT_ONLY
"""Sort attributes by visibility in the storefront"""
VISIBLE_IN_STOREFRONT
"""Sort attributes by the filterable in storefront flag"""
FILTERABLE_IN_STOREFRONT
"""Sort attributes by the filterable in dashboard flag"""
FILTERABLE_IN_DASHBOARD
"""Sort attributes by their position in storefront"""
STOREFRONT_SEARCH_POSITION
"""
Sort attributes based on whether they can be displayed or not in a product grid.
"""
AVAILABLE_IN_GRID
}
input AttributeSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort attributes by the selected field."""
field: AttributeSortField!
}
type AttributeTranslatableContent implements Node {
id: ID!
name: String!
"""Returns translated attribute fields for the given language code."""
translation(
"""A language code to return the translation for attribute."""
languageCode: LanguageCodeEnum!
): AttributeTranslation
"""Custom attribute of a product."""
attribute: Attribute @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
}
"""
Creates/updates translations for an attribute.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type AttributeTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
attribute: Attribute
}
type AttributeTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
name: String!
}
"""An enumeration."""
enum AttributeTypeEnum {
PRODUCT_TYPE
PAGE_TYPE
}
"""
Updates attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type AttributeUpdate {
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
}
input AttributeUpdateInput {
"""Name of an attribute displayed in the interface."""
name: String
"""Internal representation of an attribute name."""
slug: String
"""The unit of attribute values."""
unit: MeasurementUnitsEnum
"""IDs of values to be removed from this attribute."""
removeValues: [ID!]
"""New values to be created for this attribute."""
addValues: [AttributeValueUpdateInput!]
"""Whether the attribute requires values to be passed or not."""
valueRequired: Boolean
"""Whether the attribute is for variants only."""
isVariantOnly: Boolean
"""Whether the attribute should be visible or not in storefront."""
visibleInStorefront: Boolean
"""Whether the attribute can be filtered in storefront."""
filterableInStorefront: Boolean
"""Whether the attribute can be filtered in dashboard."""
filterableInDashboard: Boolean
"""
The position of the attribute in the storefront navigation (0 by default).
"""
storefrontSearchPosition: Int
"""Whether the attribute can be displayed in the admin product list."""
availableInGrid: Boolean
}
"""
Event sent when attribute is updated.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AttributeUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The attribute the event relates to."""
attribute: Attribute
}
"""Represents a value of an attribute."""
type AttributeValue implements Node {
id: ID!
"""Name of a value displayed in the interface."""
name: String
"""Internal representation of a value (unique per attribute)."""
slug: String
"""
Represent value of the attribute value (e.g. color values for swatch attributes).
"""
value: String
"""Returns translated attribute value fields for the given language code."""
translation(
"""A language code to return the translation for attribute value."""
languageCode: LanguageCodeEnum!
): AttributeValueTranslation
"""The input type to use for entering attribute values in the dashboard."""
inputType: AttributeInputTypeEnum
"""The ID of the attribute reference."""
reference: ID
"""Represents file URL and content type (if attribute value is a file)."""
file: File
"""
Represents the text of the attribute value, includes formatting.
Rich text format. For reference see https://editorjs.io/
"""
richText: JSONString
"""
Represents the text of the attribute value, plain text without formating.
"""
plainText: String
"""Represents the boolean value of the attribute value."""
boolean: Boolean
"""Represents the date value of the attribute value."""
date: Date
"""Represents the date/time value of the attribute value."""
dateTime: DateTime
}
"""
Deletes values of attributes.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type AttributeValueBulkDelete {
"""Returns how many objects were affected."""
count: Int!
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
}
type AttributeValueCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AttributeValueCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type AttributeValueCountableEdge {
"""The item at the end of the edge."""
node: AttributeValue!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a value for an attribute.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type AttributeValueCreate {
"""The updated attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
attributeValue: AttributeValue
}
input AttributeValueCreateInput {
"""
Represent value of the attribute value (e.g. color values for swatch attributes).
"""
value: String
"""
Represents the text of the attribute value, includes formatting.
Rich text format. For reference see https://editorjs.io/
DEPRECATED: 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.
"""
richText: JSONString
"""
Represents the text of the attribute value, plain text without formating.
DEPRECATED: 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.
"""
plainText: String
"""URL of the file attribute. Every time, a new value is created."""
fileUrl: String
"""File content type."""
contentType: String
"""Name of a value displayed in the interface."""
name: String!
}
"""
Event sent when new attribute value is created.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AttributeValueCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The attribute value the event relates to."""
attributeValue: AttributeValue
}
"""
Deletes a value of an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type AttributeValueDelete {
"""The updated attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
attributeValue: AttributeValue
}
"""
Event sent when attribute value is deleted.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AttributeValueDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The attribute value the event relates to."""
attributeValue: AttributeValue
}
input AttributeValueFilterInput {
search: String
ids: [ID!]
}
input AttributeValueInput {
"""ID of the selected attribute."""
id: ID
"""
The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
"""
values: [String!]
"""URL of the file attribute. Every time, a new value is created."""
file: String
"""File content type."""
contentType: String
"""List of entity IDs that will be used as references."""
references: [ID!]
"""Text content in JSON format."""
richText: JSONString
"""Plain text content."""
plainText: String
"""Represents the boolean value of the attribute value."""
boolean: Boolean
"""Represents the date value of the attribute value."""
date: Date
"""Represents the date/time value of the attribute value."""
dateTime: DateTime
}
type AttributeValueTranslatableContent implements Node {
id: ID!
name: String!
"""
Attribute value.
Rich text format. For reference see https://editorjs.io/
"""
richText: JSONString
"""Attribute plain text value."""
plainText: String
"""Returns translated attribute value fields for the given language code."""
translation(
"""A language code to return the translation for attribute value."""
languageCode: LanguageCodeEnum!
): AttributeValueTranslation
"""Represents a value of an attribute."""
attributeValue: AttributeValue @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
"""
Associated attribute that can be translated.
Added in Saleor 3.9.
"""
attribute: AttributeTranslatableContent
}
"""
Creates/updates translations for an attribute value.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type AttributeValueTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
attributeValue: AttributeValue
}
type AttributeValueTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
name: String!
"""
Attribute value.
Rich text format. For reference see https://editorjs.io/
"""
richText: JSONString
"""Attribute plain text value."""
plainText: String
}
input AttributeValueTranslationInput {
name: String
"""
Translated text.
Rich text format. For reference see https://editorjs.io/
"""
richText: JSONString
"""Translated text."""
plainText: String
}
"""
Updates value of an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type AttributeValueUpdate {
"""The updated attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AttributeError!]!
attributeValue: AttributeValue
}
input AttributeValueUpdateInput {
"""
Represent value of the attribute value (e.g. color values for swatch attributes).
"""
value: String
"""
Represents the text of the attribute value, includes formatting.
Rich text format. For reference see https://editorjs.io/
DEPRECATED: 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.
"""
richText: JSONString
"""
Represents the text of the attribute value, plain text without formating.
DEPRECATED: 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.
"""
plainText: String
"""URL of the file attribute. Every time, a new value is created."""
fileUrl: String
"""File content type."""
contentType: String
"""Name of a value displayed in the interface."""
name: String
}
"""
Event sent when attribute value is updated.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type AttributeValueUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The attribute value the event relates to."""
attributeValue: AttributeValue
}
input BulkAttributeValueInput {
"""ID of the selected attribute."""
id: ID
"""
The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
"""
values: [String!]
"""
The boolean value of an attribute to resolve. If the passed value is non-existent, it will be created.
"""
boolean: Boolean
}
type BulkProductError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ProductErrorCode!
"""List of attributes IDs which causes the error."""
attributes: [ID!]
"""List of attribute values IDs which causes the error."""
values: [ID!]
"""Index of an input list item that caused the error."""
index: Int
"""List of warehouse IDs which causes the error."""
warehouses: [ID!]
"""List of channel IDs which causes the error."""
channels: [ID!]
}
type BulkStockError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ProductErrorCode!
"""List of attributes IDs which causes the error."""
attributes: [ID!]
"""List of attribute values IDs which causes the error."""
values: [ID!]
"""Index of an input list item that caused the error."""
index: Int
}
"""
Synchronous webhook for calculating checkout/order taxes.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CalculateTaxes implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
taxBase: TaxableObject!
}
input CardInput {
"""
Payment method nonce, a token returned by the appropriate provider's SDK.
"""
code: String!
"""Card security code."""
cvc: String
"""Information about currency and amount."""
money: MoneyInput!
}
input CatalogueInput {
"""Products related to the discount."""
products: [ID!]
"""Categories related to the discount."""
categories: [ID!]
"""Collections related to the discount."""
collections: [ID!]
"""
Product variant related to the discount.
Added in Saleor 3.1.
"""
variants: [ID!]
}
"""
Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront.
"""
type Category implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
seoTitle: String
seoDescription: String
name: String!
"""
Description of the category.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
slug: String!
parent: Category
level: Int!
"""
Description of the category.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
"""List of ancestors of the category."""
ancestors(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CategoryCountableConnection
"""
List of products in the category. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
products(
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductCountableConnection
"""List of children of the category."""
children(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CategoryCountableConnection
backgroundImage(
"""
Size of the image. If not provided, the original image will be returned.
"""
size: Int
"""
The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
format: ThumbnailFormatEnum
): Image
"""Returns translated category fields for the given language code."""
translation(
"""A language code to return the translation for category."""
languageCode: LanguageCodeEnum!
): CategoryTranslation
}
"""
Deletes categories.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CategoryBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
type CategoryCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [CategoryCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type CategoryCountableEdge {
"""The item at the end of the edge."""
node: Category!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CategoryCreate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
category: Category
}
"""
Event sent when new category is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CategoryCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The category the event relates to."""
category: Category
}
"""
Deletes a category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CategoryDelete {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
category: Category
}
"""
Event sent when category is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CategoryDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The category the event relates to."""
category: Category
}
input CategoryFilterInput {
search: String
metadata: [MetadataFilter!]
ids: [ID!]
slugs: [String!]
}
input CategoryInput {
"""
Category description.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Category name."""
name: String
"""Category slug."""
slug: String
"""Search engine optimization fields."""
seo: SeoInput
"""Background image file."""
backgroundImage: Upload
"""Alt text for a product media."""
backgroundImageAlt: String
"""
Fields required to update the category metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the category private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
}
enum CategorySortField {
"""Sort categories by name."""
NAME
"""Sort categories by product count."""
PRODUCT_COUNT
"""Sort categories by subcategory count."""
SUBCATEGORY_COUNT
}
input CategorySortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
"""Sort categories by the selected field."""
field: CategorySortField!
}
type CategoryTranslatableContent implements Node {
id: ID!
seoTitle: String
seoDescription: String
name: String!
"""
Description of the category.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""
Description of the category.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
"""Returns translated category fields for the given language code."""
translation(
"""A language code to return the translation for category."""
languageCode: LanguageCodeEnum!
): CategoryTranslation
"""Represents a single category of products."""
category: Category @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
}
"""
Creates/updates translations for a category.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type CategoryTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
category: Category
}
type CategoryTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
seoTitle: String
seoDescription: String
name: String
"""
Translated description of the category.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""
Translated description of the category.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
}
"""
Updates a category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CategoryUpdate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
category: Category
}
"""
Event sent when category is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CategoryUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The category the event relates to."""
category: Category
}
"""Represents channel."""
type Channel implements Node {
id: ID!
"""Slug of the channel."""
slug: String!
"""
Name of the channel.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
name: String!
"""
Whether the channel is active.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
isActive: Boolean!
"""
A currency that is assigned to the channel.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
currencyCode: String!
"""
Whether a channel has associated orders.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
hasOrders: Boolean!
"""
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.
Added in Saleor 3.1.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
defaultCountry: CountryDisplay!
"""
List of warehouses assigned to this channel.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
warehouses: [Warehouse!]!
"""
List of shippable countries for the channel.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
countries: [CountryDisplay!]
"""
Shipping methods that are available for the channel.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
availableShippingMethodsPerCountry(countries: [CountryCode!]): [ShippingMethodsPerCountry!]
"""
Define the stock setting for this channel.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
stockSettings: StockSettings!
}
"""
Activate a channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
type ChannelActivate {
"""Activated channel."""
channel: Channel
channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ChannelError!]!
}
"""
Creates new channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
type ChannelCreate {
channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ChannelError!]!
channel: Channel
}
input ChannelCreateInput {
"""isActive flag."""
isActive: Boolean
"""
The channel stock settings.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
stockSettings: StockSettingsInput
"""List of shipping zones to assign to the channel."""
addShippingZones: [ID!]
"""
List of warehouses to assign to the channel.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
addWarehouses: [ID!]
"""Name of the channel."""
name: String!
"""Slug of the channel."""
slug: String!
"""Currency of the channel."""
currencyCode: String!
"""
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.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
defaultCountry: CountryCode!
}
"""
Event sent when new channel is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ChannelCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The channel the event relates to."""
channel: Channel
}
"""
Event sent when new channel is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ChannelCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The channel the event relates to."""
channel: Channel
}
"""
Deactivate a channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
type ChannelDeactivate {
"""Deactivated channel."""
channel: Channel
channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ChannelError!]!
}
"""
Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
type ChannelDelete {
channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ChannelError!]!
channel: Channel
}
input ChannelDeleteInput {
"""ID of channel to migrate orders from origin channel."""
channelId: ID!
}
"""
Event sent when channel is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ChannelDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The channel the event relates to."""
channel: Channel
}
type ChannelError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ChannelErrorCode!
"""List of shipping zone IDs which causes the error."""
shippingZones: [ID!]
"""List of warehouses IDs which causes the error."""
warehouses: [ID!]
}
"""An enumeration."""
enum ChannelErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
CHANNELS_CURRENCY_MUST_BE_THE_SAME
CHANNEL_WITH_ORDERS
DUPLICATED_INPUT_ITEM
}
"""
Reorder the warehouses of a channel.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
type ChannelReorderWarehouses {
"""Channel within the warehouses are reordered."""
channel: Channel
errors: [ChannelError!]!
}
"""
Event sent when channel status has changed.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ChannelStatusChanged implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The channel the event relates to."""
channel: Channel
}
"""
Update a channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
type ChannelUpdate {
channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ChannelError!]!
channel: Channel
}
input ChannelUpdateInput {
"""isActive flag."""
isActive: Boolean
"""
The channel stock settings.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
stockSettings: StockSettingsInput
"""List of shipping zones to assign to the channel."""
addShippingZones: [ID!]
"""
List of warehouses to assign to the channel.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
addWarehouses: [ID!]
"""Name of the channel."""
name: String
"""Slug of the channel."""
slug: String
"""
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.
Added in Saleor 3.1.
"""
defaultCountry: CountryCode
"""List of shipping zones to unassign from the channel."""
removeShippingZones: [ID!]
"""
List of warehouses to unassign from the channel.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
removeWarehouses: [ID!]
}
"""
Event sent when channel is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ChannelUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The channel the event relates to."""
channel: Channel
}
"""Checkout object."""
type Checkout implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
created: DateTime!
lastChange: DateTime!
user: User
channel: Channel!
billingAddress: Address
shippingAddress: Address
note: String!
discount: Money
discountName: String
translatedDiscountName: String
voucherCode: String
"""Shipping methods that can be used with this checkout."""
availableShippingMethods: [ShippingMethod!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `shippingMethods` instead.")
"""Shipping methods that can be used with this checkout."""
shippingMethods: [ShippingMethod!]!
"""
Collection points that can be used for this order.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
availableCollectionPoints: [Warehouse!]!
"""List of available payment gateways."""
availablePaymentGateways: [PaymentGateway!]!
"""Email of a customer."""
email: String
"""List of gift cards associated with this checkout."""
giftCards: [GiftCard!]!
"""Returns True, if checkout requires shipping."""
isShippingRequired: Boolean!
"""The number of items purchased."""
quantity: Int!
"""
Date when oldest stock reservation for this checkout expires or null if no stock is reserved.
Added in Saleor 3.1.
"""
stockReservationExpires: DateTime
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLine!]!
"""The price of the shipping, with all the taxes included."""
shippingPrice: TaxedMoney!
"""The shipping method related with checkout."""
shippingMethod: ShippingMethod @deprecated(reason: "This field will be removed in Saleor 4.0. Use `deliveryMethod` instead.")
"""
The delivery method selected for this checkout.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
deliveryMethod: DeliveryMethod
"""The price of the checkout before shipping, with taxes included."""
subtotalPrice: TaxedMoney!
"""
Returns True if checkout has to be exempt from taxes.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
taxExemption: Boolean!
"""The checkout's token."""
token: UUID!
"""
The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included.
"""
totalPrice: TaxedMoney!
"""Checkout language code."""
languageCode: LanguageCodeEnum!
"""
List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
transactions: [TransactionItem!]
"""
Determines whether checkout prices should include taxes when displayed in a storefront.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
displayGrossPrices: Boolean!
}
"""Adds a gift card or a voucher to a checkout."""
type CheckoutAddPromoCode {
"""The checkout with the added gift card or voucher."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
input CheckoutAddressValidationRules {
"""
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.
"""
checkRequiredFields: Boolean = true
"""
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.
"""
checkFieldsFormat: Boolean = true
"""
Determines if Saleor should apply normalization on address fields. Example: converting city field to uppercase letters.
"""
enableFieldsNormalization: Boolean = true
}
"""Update billing address in the existing checkout."""
type CheckoutBillingAddressUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""
Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.
"""
type CheckoutComplete {
"""Placed order."""
order: Order
"""
Set to true if payment needs to be confirmed before checkout is complete.
"""
confirmationNeeded: Boolean!
"""Confirmation data used to process additional authorization steps."""
confirmationData: JSONString
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
type CheckoutCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [CheckoutCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type CheckoutCountableEdge {
"""The item at the end of the edge."""
node: Checkout!
"""A cursor for use in pagination."""
cursor: String!
}
"""Create a new checkout."""
type CheckoutCreate {
"""
Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout.
"""
created: Boolean @deprecated(reason: "This field will be removed in Saleor 4.0. Always returns `true`.")
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
checkout: Checkout
}
input CheckoutCreateInput {
"""Slug of a channel in which to create a checkout."""
channel: String
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLineInput!]!
"""The customer's email address."""
email: String
"""
The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items.
"""
shippingAddress: AddressInput
"""Billing address of the customer."""
billingAddress: AddressInput
"""Checkout language code."""
languageCode: LanguageCodeEnum
"""
The checkout validation rules that can be changed.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
validationRules: CheckoutValidationRules
}
"""
Event sent when new checkout is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CheckoutCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The checkout the event relates to."""
checkout: Checkout
}
"""
Sets the customer as the owner of the checkout.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.
"""
type CheckoutCustomerAttach {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""
Removes the user assigned as the owner of the checkout.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.
"""
type CheckoutCustomerDetach {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""
Updates the delivery method (shipping method or pick up point) of the checkout.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CheckoutDeliveryMethodUpdate {
"""An updated checkout."""
checkout: Checkout
errors: [CheckoutError!]!
}
"""Updates email address in the existing checkout object."""
type CheckoutEmailUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
type CheckoutError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: CheckoutErrorCode!
"""List of varint IDs which causes the error."""
variants: [ID!]
"""List of line Ids which cause the error."""
lines: [ID!]
"""A type of address that causes the error."""
addressType: AddressTypeEnum
}
"""An enumeration."""
enum CheckoutErrorCode {
BILLING_ADDRESS_NOT_SET
CHECKOUT_NOT_FULLY_PAID
GRAPHQL_ERROR
PRODUCT_NOT_PUBLISHED
PRODUCT_UNAVAILABLE_FOR_PURCHASE
INSUFFICIENT_STOCK
INVALID
INVALID_SHIPPING_METHOD
NOT_FOUND
PAYMENT_ERROR
QUANTITY_GREATER_THAN_LIMIT
REQUIRED
SHIPPING_ADDRESS_NOT_SET
SHIPPING_METHOD_NOT_APPLICABLE
DELIVERY_METHOD_NOT_APPLICABLE
SHIPPING_METHOD_NOT_SET
SHIPPING_NOT_REQUIRED
TAX_ERROR
UNIQUE
VOUCHER_NOT_APPLICABLE
GIFT_CARD_NOT_APPLICABLE
ZERO_QUANTITY
MISSING_CHANNEL_SLUG
CHANNEL_INACTIVE
UNAVAILABLE_VARIANT_IN_CHANNEL
EMAIL_NOT_SET
NO_LINES
INACTIVE_PAYMENT
}
input CheckoutFilterInput {
customer: String
created: DateRangeInput
search: String
metadata: [MetadataFilter!]
channels: [ID!]
}
"""
Filter shipping methods for checkout.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CheckoutFilterShippingMethods implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The checkout the event relates to."""
checkout: Checkout
"""
Shipping methods that can be used with this checkout.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
shippingMethods: [ShippingMethod!]
}
"""Update language code in the existing checkout."""
type CheckoutLanguageCodeUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""Represents an item in the checkout."""
type CheckoutLine implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
variant: ProductVariant!
quantity: Int!
"""The unit price of the checkout line, with taxes and discounts."""
unitPrice: TaxedMoney!
"""The unit price of the checkout line, without discounts."""
undiscountedUnitPrice: Money!
"""The sum of the checkout line price, taxes and discounts."""
totalPrice: TaxedMoney!
"""The sum of the checkout line price, without discounts."""
undiscountedTotalPrice: Money!
"""Indicates whether the item need to be delivered."""
requiresShipping: Boolean!
}
type CheckoutLineCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [CheckoutLineCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type CheckoutLineCountableEdge {
"""The item at the end of the edge."""
node: CheckoutLine!
"""A cursor for use in pagination."""
cursor: String!
}
"""Deletes a CheckoutLine."""
type CheckoutLineDelete {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
input CheckoutLineInput {
"""The number of items purchased."""
quantity: Int!
"""ID of the product variant."""
variantId: ID!
"""
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.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
price: PositiveDecimal
"""
Flag that allow force splitting the same variant into multiple lines by skipping the matching logic.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
forceNewLine: Boolean = false
"""
Fields required to update the object's metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
}
input CheckoutLineUpdateInput {
"""
ID of the product variant.
DEPRECATED: this field will be removed in Saleor 4.0. Use `lineId` instead.
"""
variantId: ID
"""
The number of items purchased. Optional for apps, required for any other users.
"""
quantity: Int
"""
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.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
price: PositiveDecimal
"""
ID of the line.
Added in Saleor 3.6.
"""
lineId: ID
}
"""
Adds a checkout line to the existing checkout.If line was already in checkout, its quantity will be increased.
"""
type CheckoutLinesAdd {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""Deletes checkout lines."""
type CheckoutLinesDelete {
"""An updated checkout."""
checkout: Checkout
errors: [CheckoutError!]!
}
"""Updates checkout line in the existing checkout."""
type CheckoutLinesUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""
Event sent when checkout metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CheckoutMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The checkout the event relates to."""
checkout: Checkout
}
"""Create a new payment for given checkout."""
type CheckoutPaymentCreate {
"""Related checkout object."""
checkout: Checkout
"""A newly created payment."""
payment: Payment
paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PaymentError!]!
}
"""Remove a gift card or a voucher from a checkout."""
type CheckoutRemovePromoCode {
"""The checkout with the removed gift card or voucher."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""Update shipping address in the existing checkout."""
type CheckoutShippingAddressUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
"""Updates the shipping method of the checkout."""
type CheckoutShippingMethodUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CheckoutError!]!
}
enum CheckoutSortField {
"""Sort checkouts by creation date."""
CREATION_DATE
"""Sort checkouts by customer."""
CUSTOMER
"""Sort checkouts by payment."""
PAYMENT
}
input CheckoutSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort checkouts by the selected field."""
field: CheckoutSortField!
}
"""
Event sent when checkout is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CheckoutUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The checkout the event relates to."""
checkout: Checkout
}
input CheckoutValidationRules {
"""
The validation rules that can be applied to provided shipping address data.
"""
shippingAddress: CheckoutAddressValidationRules
"""
The validation rules that can be applied to provided billing address data.
"""
billingAddress: CheckoutAddressValidationRules
}
type ChoiceValue {
raw: String
verbose: String
}
"""Represents a collection of products."""
type Collection implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
seoTitle: String
seoDescription: String
name: String!
"""
Description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
slug: String!
"""
Channel given to retrieve this collection. Also used by federation gateway to resolve this object in a federated query.
"""
channel: String
"""
Description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
"""List of products in this collection."""
products(
"""Filtering options for products."""
filter: ProductFilterInput
"""Sort products."""
sortBy: ProductOrder
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductCountableConnection
backgroundImage(
"""
Size of the image. If not provided, the original image will be returned.
"""
size: Int
"""
The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
format: ThumbnailFormatEnum
): Image
"""Returns translated collection fields for the given language code."""
translation(
"""A language code to return the translation for collection."""
languageCode: LanguageCodeEnum!
): CollectionTranslation
"""
List of channels in which the collection is available.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
channelListings: [CollectionChannelListing!]
}
"""
Adds products to a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionAddProducts {
"""Collection to which products will be added."""
collection: Collection
collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionError!]!
}
"""
Deletes collections.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionBulkDelete {
"""Returns how many objects were affected."""
count: Int!
collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionError!]!
}
"""Represents collection channel listing."""
type CollectionChannelListing implements Node {
id: ID!
publicationDate: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date.")
"""
The collection publication date.
Added in Saleor 3.3.
"""
publishedAt: DateTime
isPublished: Boolean!
channel: Channel!
}
type CollectionChannelListingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ProductErrorCode!
"""List of attributes IDs which causes the error."""
attributes: [ID!]
"""List of attribute values IDs which causes the error."""
values: [ID!]
"""List of channels IDs which causes the error."""
channels: [ID!]
}
"""
Manage collection's availability in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionChannelListingUpdate {
"""An updated collection instance."""
collection: Collection
collectionChannelListingErrors: [CollectionChannelListingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionChannelListingError!]!
}
input CollectionChannelListingUpdateInput {
"""List of channels to which the collection should be assigned."""
addChannels: [PublishableChannelListingInput!]
"""List of channels from which the collection should be unassigned."""
removeChannels: [ID!]
}
type CollectionCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [CollectionCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type CollectionCountableEdge {
"""The item at the end of the edge."""
node: Collection!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionCreate {
collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionError!]!
collection: Collection
}
input CollectionCreateInput {
"""Informs whether a collection is published."""
isPublished: Boolean
"""Name of the collection."""
name: String
"""Slug of the collection."""
slug: String
"""
Description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Background image file."""
backgroundImage: Upload
"""Alt text for an image."""
backgroundImageAlt: String
"""Search engine optimization fields."""
seo: SeoInput
"""
Publication date. ISO 8601 standard.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
publicationDate: Date
"""
Fields required to update the collection metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the collection private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
"""List of products to be added to the collection."""
products: [ID!]
}
"""
Event sent when new collection is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CollectionCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The collection the event relates to."""
collection(
"""Slug of a channel for which the data should be returned."""
channel: String
): Collection
}
"""
Event sent when new collection is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CollectionCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The collection the event relates to."""
collection(
"""Slug of a channel for which the data should be returned."""
channel: String
): Collection
}
"""
Deletes a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionDelete {
collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionError!]!
collection: Collection
}
"""
Event sent when collection is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CollectionDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The collection the event relates to."""
collection(
"""Slug of a channel for which the data should be returned."""
channel: String
): Collection
}
type CollectionError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""List of products IDs which causes the error."""
products: [ID!]
"""The error code."""
code: CollectionErrorCode!
}
"""An enumeration."""
enum CollectionErrorCode {
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT
}
input CollectionFilterInput {
published: CollectionPublished
search: String
metadata: [MetadataFilter!]
ids: [ID!]
slugs: [String!]
"""
Specifies the channel by which the data should be filtered.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
}
input CollectionInput {
"""Informs whether a collection is published."""
isPublished: Boolean
"""Name of the collection."""
name: String
"""Slug of the collection."""
slug: String
"""
Description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Background image file."""
backgroundImage: Upload
"""Alt text for an image."""
backgroundImageAlt: String
"""Search engine optimization fields."""
seo: SeoInput
"""
Publication date. ISO 8601 standard.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
publicationDate: Date
"""
Fields required to update the collection metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the collection private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
}
"""
Event sent when collection metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CollectionMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The collection the event relates to."""
collection(
"""Slug of a channel for which the data should be returned."""
channel: String
): Collection
}
enum CollectionPublished {
PUBLISHED
HIDDEN
}
"""
Remove products from a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionRemoveProducts {
"""Collection from which products will be removed."""
collection: Collection
collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionError!]!
}
"""
Reorder the products of a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionReorderProducts {
"""Collection from which products are reordered."""
collection: Collection
collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionError!]!
}
enum CollectionSortField {
"""Sort collections by name."""
NAME
"""
Sort collections by availability.
This option requires a channel filter to work as the values can vary between channels.
"""
AVAILABILITY
"""Sort collections by product count."""
PRODUCT_COUNT
"""
Sort collections by publication date.
This option requires a channel filter to work as the values can vary between channels.
"""
PUBLICATION_DATE
"""
Sort collections by publication date.
This option requires a channel filter to work as the values can vary between channels.
"""
PUBLISHED_AT
}
input CollectionSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
"""Sort collections by the selected field."""
field: CollectionSortField!
}
type CollectionTranslatableContent implements Node {
id: ID!
seoTitle: String
seoDescription: String
name: String!
"""
Description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""
Description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
"""Returns translated collection fields for the given language code."""
translation(
"""A language code to return the translation for collection."""
languageCode: LanguageCodeEnum!
): CollectionTranslation
"""Represents a collection of products."""
collection: Collection @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
}
"""
Creates/updates translations for a collection.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type CollectionTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
collection: Collection
}
type CollectionTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
seoTitle: String
seoDescription: String
name: String
"""
Translated description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""
Translated description of the collection.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
}
"""
Updates a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type CollectionUpdate {
collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [CollectionError!]!
collection: Collection
}
"""
Event sent when collection is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CollectionUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The collection the event relates to."""
collection(
"""Slug of a channel for which the data should be returned."""
channel: String
): Collection
}
"""Stores information about a single configuration field."""
type ConfigurationItem {
"""Name of the field."""
name: String!
"""Current value of the field."""
value: String
"""Type of the field."""
type: ConfigurationTypeFieldEnum
"""Help text for the field."""
helpText: String
"""Label for the field."""
label: String
}
input ConfigurationItemInput {
"""Name of the field to update."""
name: String!
"""Value of the given field to update."""
value: String
}
"""An enumeration."""
enum ConfigurationTypeFieldEnum {
STRING
MULTILINE
BOOLEAN
SECRET
PASSWORD
SECRETMULTILINE
OUTPUT
}
"""Confirm user account with token sent by email during registration."""
type ConfirmAccount {
"""An activated user account."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Confirm the email change of the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type ConfirmEmailChange {
"""A user instance with a new email."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""An enumeration."""
enum CountryCode {
AF
AX
AL
DZ
AS
AD
AO
AI
AQ
AG
AR
AM
AW
AU
AT
AZ
BS
BH
BD
BB
BY
BE
BZ
BJ
BM
BT
BO
BQ
BA
BW
BV
BR
IO
BN
BG
BF
BI
CV
KH
CM
CA
KY
CF
TD
CL
CN
CX
CC
CO
KM
CG
CD
CK
CR
CI
HR
CU
CW
CY
CZ
DK
DJ
DM
DO
EC
EG
SV
GQ
ER
EE
SZ
ET
EU
FK
FO
FJ
FI
FR
GF
PF
TF
GA
GM
GE
DE
GH
GI
GR
GL
GD
GP
GU
GT
GG
GN
GW
GY
HT
HM
VA
HN
HK
HU
IS
IN
ID
IR
IQ
IE
IM
IL
IT
JM
JP
JE
JO
KZ
KE
KI
KW
KG
LA
LV
LB
LS
LR
LY
LI
LT
LU
MO
MG
MW
MY
MV
ML
MT
MH
MQ
MR
MU
YT
MX
FM
MD
MC
MN
ME
MS
MA
MZ
MM
NA
NR
NP
NL
NC
NZ
NI
NE
NG
NU
NF
KP
MK
MP
NO
OM
PK
PW
PS
PA
PG
PY
PE
PH
PN
PL
PT
PR
QA
RE
RO
RU
RW
BL
SH
KN
LC
MF
PM
VC
WS
SM
ST
SA
SN
RS
SC
SL
SG
SX
SK
SI
SB
SO
ZA
GS
KR
SS
ES
LK
SD
SR
SJ
SE
CH
SY
TW
TJ
TZ
TH
TL
TG
TK
TO
TT
TN
TR
TM
TC
TV
UG
UA
AE
GB
UM
US
UY
UZ
VU
VE
VN
VG
VI
WF
EH
YE
ZM
ZW
}
type CountryDisplay {
"""Country code."""
code: String!
"""Country name."""
country: String!
"""Country tax."""
vat: VAT @deprecated(reason: "This field will be removed in Saleor 4.0. Use `TaxClassCountryRate` type to manage tax rates per country.")
}
input CountryFilterInput {
"""
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.
"""
attachedToShippingZones: Boolean
}
input CountryRateInput {
"""Country in which this rate applies."""
countryCode: CountryCode!
"""
Tax rate value provided as percentage. Example: provide `23` to represent `23%` tax rate.
"""
rate: Float!
}
input CountryRateUpdateInput {
"""Country in which this rate applies."""
countryCode: CountryCode!
"""
Tax rate value provided as percentage. Example: provide `23` to represent `23%` tax rate. Provide `null` to remove the particular rate.
"""
rate: Float
}
"""Create JWT token."""
type CreateToken {
"""JWT token, required to authenticate."""
token: String
"""JWT refresh token, required to re-generate access token."""
refreshToken: String
"""CSRF token required to re-generate access token."""
csrfToken: String
"""A user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
type CreditCard {
"""Card brand."""
brand: String!
"""First 4 digits of the card number."""
firstDigits: String
"""Last 4 digits of the card number."""
lastDigits: String!
"""Two-digit number representing the cards expiration month."""
expMonth: Int
"""Four-digit number representing the cards expiration year."""
expYear: Int
}
"""
Deletes customers.
Requires one of the following permissions: MANAGE_USERS.
"""
type CustomerBulkDelete {
"""Returns how many objects were affected."""
count: Int!
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Creates a new customer.
Requires one of the following permissions: MANAGE_USERS.
"""
type CustomerCreate {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""
Event sent when new customer user is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CustomerCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The user the event relates to."""
user: User
}
"""
Deletes a customer.
Requires one of the following permissions: MANAGE_USERS.
"""
type CustomerDelete {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""History log of the customer."""
type CustomerEvent implements Node {
id: ID!
"""Date when event happened at in ISO 8601 format."""
date: DateTime
"""Customer event type."""
type: CustomerEventsEnum
"""User who performed the action."""
user: User
"""App that performed the action."""
app: App
"""Content of the event."""
message: String
"""Number of objects concerned by the event."""
count: Int
"""The concerned order."""
order: Order
"""The concerned order line."""
orderLine: OrderLine
}
"""An enumeration."""
enum CustomerEventsEnum {
ACCOUNT_CREATED
ACCOUNT_ACTIVATED
ACCOUNT_DEACTIVATED
PASSWORD_RESET_LINK_SENT
PASSWORD_RESET
EMAIL_CHANGED_REQUEST
PASSWORD_CHANGED
EMAIL_CHANGED
PLACED_ORDER
NOTE_ADDED_TO_ORDER
DIGITAL_LINK_DOWNLOADED
CUSTOMER_DELETED
NAME_ASSIGNED
EMAIL_ASSIGNED
NOTE_ADDED
}
input CustomerFilterInput {
dateJoined: DateRangeInput
numberOfOrders: IntRangeInput
placedOrders: DateRangeInput
search: String
metadata: [MetadataFilter!]
"""
Filter by ids.
Added in Saleor 3.8.
"""
ids: [ID!]
updatedAt: DateTimeRangeInput
}
input CustomerInput {
"""Billing address of the customer."""
defaultBillingAddress: AddressInput
"""Shipping address of the customer."""
defaultShippingAddress: AddressInput
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""The unique email address of the user."""
email: String
"""User account is active."""
isActive: Boolean
"""A note about the user."""
note: String
"""User language code."""
languageCode: LanguageCodeEnum
}
"""
Event sent when customer user metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CustomerMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The user the event relates to."""
user: User
}
"""
Updates an existing customer.
Requires one of the following permissions: MANAGE_USERS.
"""
type CustomerUpdate {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""
Event sent when customer user is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type CustomerUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The user the event relates to."""
user: User
}
"""
The `Date` scalar type represents a Date
value as specified by
[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
"""
scalar Date
input DateRangeInput {
"""Start date."""
gte: Date
"""End date."""
lte: Date
}
"""
The `DateTime` scalar type represents a DateTime
value as specified by
[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
"""
scalar DateTime
input DateTimeRangeInput {
"""Start date."""
gte: DateTime
"""End date."""
lte: DateTime
}
"""
Deactivate all JWT tokens of the currently authenticated user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type DeactivateAllUserTokens {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Delete metadata of an object. To use it, you need to have access to the modified object.
"""
type DeleteMetadata {
metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MetadataError!]!
item: ObjectWithMetadata
}
"""
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.
"""
type DeletePrivateMetadata {
metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MetadataError!]!
item: ObjectWithMetadata
}
"""
Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
union DeliveryMethod = Warehouse | ShippingMethod
type DigitalContent implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
useDefaultSettings: Boolean!
automaticFulfillment: Boolean!
contentFile: String!
maxDownloads: Int
urlValidDays: Int
"""List of URLs for the digital variant."""
urls: [DigitalContentUrl!]
"""Product variant assigned to digital content."""
productVariant: ProductVariant!
}
type DigitalContentCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [DigitalContentCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type DigitalContentCountableEdge {
"""The item at the end of the edge."""
node: DigitalContent!
"""A cursor for use in pagination."""
cursor: String!
}
"""
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
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type DigitalContentCreate {
variant: ProductVariant
content: DigitalContent
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""
Remove digital content assigned to given variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type DigitalContentDelete {
variant: ProductVariant
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
input DigitalContentInput {
"""Use default digital content settings for this product."""
useDefaultSettings: Boolean!
"""
Determines how many times a download link can be accessed by a customer.
"""
maxDownloads: Int
"""
Determines for how many days a download link is active since it was generated.
"""
urlValidDays: Int
"""Overwrite default automatic_fulfillment setting for variant."""
automaticFulfillment: Boolean
"""
Fields required to update the digital content metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the digital content private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
}
"""
Update digital content.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type DigitalContentUpdate {
variant: ProductVariant
content: DigitalContent
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
input DigitalContentUploadInput {
"""Use default digital content settings for this product."""
useDefaultSettings: Boolean!
"""
Determines how many times a download link can be accessed by a customer.
"""
maxDownloads: Int
"""
Determines for how many days a download link is active since it was generated.
"""
urlValidDays: Int
"""Overwrite default automatic_fulfillment setting for variant."""
automaticFulfillment: Boolean
"""
Fields required to update the digital content metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the digital content private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
"""Represents an file in a multipart request."""
contentFile: Upload!
}
type DigitalContentUrl implements Node {
id: ID!
content: DigitalContent!
created: DateTime!
downloadNum: Int!
"""URL for digital content."""
url: String
"""UUID of digital content."""
token: UUID!
}
"""
Generate new URL to digital content.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type DigitalContentUrlCreate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
digitalContentUrl: DigitalContentUrl
}
input DigitalContentUrlCreateInput {
"""Digital content ID which URL will belong to."""
content: ID!
}
type DiscountError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""List of products IDs which causes the error."""
products: [ID!]
"""The error code."""
code: DiscountErrorCode!
"""List of channels IDs which causes the error."""
channels: [ID!]
}
"""An enumeration."""
enum DiscountErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT
DUPLICATED_INPUT_ITEM
}
enum DiscountStatusEnum {
ACTIVE
EXPIRED
SCHEDULED
}
enum DiscountValueTypeEnum {
FIXED
PERCENTAGE
}
"""An enumeration."""
enum DistanceUnitsEnum {
CM
M
KM
FT
YD
INCH
}
"""Represents shop's domain."""
type Domain {
"""The host name of the domain."""
host: String!
"""Inform if SSL is enabled."""
sslEnabled: Boolean!
"""Shop's absolute URL."""
url: String!
}
"""
Deletes draft orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type DraftOrderBulkDelete {
"""Returns how many objects were affected."""
count: Int!
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Completes creating an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type DraftOrderComplete {
"""Completed order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Creates a new draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type DraftOrderCreate {
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
order: Order
}
input DraftOrderCreateInput {
"""Billing address of the customer."""
billingAddress: AddressInput
"""Customer associated with the draft order."""
user: ID
"""Email address of the customer."""
userEmail: String
"""Discount amount for the order."""
discount: PositiveDecimal
"""Shipping address of the customer."""
shippingAddress: AddressInput
"""ID of a selected shipping method."""
shippingMethod: ID
"""ID of the voucher associated with the order."""
voucher: ID
"""A note from a customer. Visible by customers in the order summary."""
customerNote: String
"""ID of the channel associated with the order."""
channelId: ID
"""
URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.
"""
redirectUrl: String
"""Variant line input consisting of variant ID and quantity of products."""
lines: [OrderLineCreateInput!]
}
"""
Event sent when new draft order is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type DraftOrderCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""
Event sent when new draft order is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type DraftOrderCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""
Deletes a draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type DraftOrderDelete {
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
order: Order
}
"""
Event sent when draft order is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type DraftOrderDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
input DraftOrderInput {
"""Billing address of the customer."""
billingAddress: AddressInput
"""Customer associated with the draft order."""
user: ID
"""Email address of the customer."""
userEmail: String
"""Discount amount for the order."""
discount: PositiveDecimal
"""Shipping address of the customer."""
shippingAddress: AddressInput
"""ID of a selected shipping method."""
shippingMethod: ID
"""ID of the voucher associated with the order."""
voucher: ID
"""A note from a customer. Visible by customers in the order summary."""
customerNote: String
"""ID of the channel associated with the order."""
channelId: ID
"""
URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.
"""
redirectUrl: String
}
"""
Deletes order lines.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type DraftOrderLinesBulkDelete {
"""Returns how many objects were affected."""
count: Int!
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Updates a draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type DraftOrderUpdate {
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
order: Order
}
"""
Event sent when draft order is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type DraftOrderUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
interface Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
}
"""Event delivery."""
type EventDelivery implements Node {
id: ID!
createdAt: DateTime!
"""Event delivery status."""
status: EventDeliveryStatusEnum!
"""Webhook event type."""
eventType: WebhookEventTypeEnum!
"""Event delivery attempts."""
attempts(
"""Event delivery sorter"""
sortBy: EventDeliveryAttemptSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): EventDeliveryAttemptCountableConnection
"""Event payload."""
payload: String
}
"""Event delivery attempts."""
type EventDeliveryAttempt implements Node {
id: ID!
"""Event delivery creation date and time."""
createdAt: DateTime!
"""Task id for delivery attempt."""
taskId: String
"""Delivery attempt duration."""
duration: Float
"""Delivery attempt response content."""
response: String
"""Response headers for delivery attempt."""
responseHeaders: String
"""Delivery attempt response status code."""
responseStatusCode: Int
"""Request headers for delivery attempt."""
requestHeaders: String
"""Event delivery status."""
status: EventDeliveryStatusEnum!
}
type EventDeliveryAttemptCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [EventDeliveryAttemptCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type EventDeliveryAttemptCountableEdge {
"""The item at the end of the edge."""
node: EventDeliveryAttempt!
"""A cursor for use in pagination."""
cursor: String!
}
enum EventDeliveryAttemptSortField {
"""Sort event delivery attempts by created at."""
CREATED_AT
}
input EventDeliveryAttemptSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort attempts by the selected field."""
field: EventDeliveryAttemptSortField!
}
type EventDeliveryCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [EventDeliveryCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type EventDeliveryCountableEdge {
"""The item at the end of the edge."""
node: EventDelivery!
"""A cursor for use in pagination."""
cursor: String!
}
input EventDeliveryFilterInput {
status: EventDeliveryStatusEnum
eventType: WebhookEventTypeEnum
}
"""
Retries event delivery.
Requires one of the following permissions: MANAGE_APPS.
"""
type EventDeliveryRetry {
"""Event delivery."""
delivery: EventDelivery
errors: [WebhookError!]!
}
enum EventDeliverySortField {
"""Sort event deliveries by created at."""
CREATED_AT
}
input EventDeliverySortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort deliveries by the selected field."""
field: EventDeliverySortField!
}
enum EventDeliveryStatusEnum {
PENDING
SUCCESS
FAILED
}
type ExportError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ExportErrorCode!
}
"""An enumeration."""
enum ExportErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
}
"""History log of export file."""
type ExportEvent implements Node {
"""The ID of the object."""
id: ID!
"""Date when event happened at in ISO 8601 format."""
date: DateTime!
"""Export event type."""
type: ExportEventsEnum!
"""
User who performed the action. Requires one of the following permissions: OWNER, MANAGE_STAFF.
"""
user: User
"""
App which performed the action. Requires one of the following permissions: OWNER, MANAGE_APPS.
"""
app: App
"""Content of the event."""
message: String!
}
"""An enumeration."""
enum ExportEventsEnum {
EXPORT_PENDING
EXPORT_SUCCESS
EXPORT_FAILED
EXPORT_DELETED
EXPORTED_FILE_SENT
EXPORT_FAILED_INFO_SENT
}
"""Represents a job data of exported file."""
type ExportFile implements Node & Job {
id: ID!
"""Job status."""
status: JobStatusEnum!
"""Created date time of job in ISO 8601 format."""
createdAt: DateTime!
"""Date time of job last update in ISO 8601 format."""
updatedAt: DateTime!
"""Job message."""
message: String
"""The URL of field to download."""
url: String
"""List of events associated with the export."""
events: [ExportEvent!]
user: User
app: App
}
type ExportFileCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [ExportFileCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type ExportFileCountableEdge {
"""The item at the end of the edge."""
node: ExportFile!
"""A cursor for use in pagination."""
cursor: String!
}
input ExportFileFilterInput {
createdAt: DateTimeRangeInput
updatedAt: DateTimeRangeInput
status: JobStatusEnum
user: String
app: String
}
enum ExportFileSortField {
STATUS
CREATED_AT
UPDATED_AT
LAST_MODIFIED_AT
}
input ExportFileSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort export file by the selected field."""
field: ExportFileSortField!
}
"""
Export gift cards to csv file.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type ExportGiftCards {
"""
The newly created export file job which is responsible for export data.
"""
exportFile: ExportFile
errors: [ExportError!]!
}
input ExportGiftCardsInput {
"""Determine which gift cards should be exported."""
scope: ExportScope!
"""Filtering options for gift cards."""
filter: GiftCardFilterInput
"""List of gift cards IDs to export."""
ids: [ID!]
"""Type of exported file."""
fileType: FileTypesEnum!
}
input ExportInfoInput {
"""List of attribute ids witch should be exported."""
attributes: [ID!]
"""List of warehouse ids witch should be exported."""
warehouses: [ID!]
"""List of channels ids which should be exported."""
channels: [ID!]
"""List of product fields witch should be exported."""
fields: [ProductFieldEnum!]
}
"""
Export products to csv file.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ExportProducts {
"""
The newly created export file job which is responsible for export data.
"""
exportFile: ExportFile
exportErrors: [ExportError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ExportError!]!
}
input ExportProductsInput {
"""Determine which products should be exported."""
scope: ExportScope!
"""Filtering options for products."""
filter: ProductFilterInput
"""List of products IDs to export."""
ids: [ID!]
"""Input with info about fields which should be exported."""
exportInfo: ExportInfoInput
"""Type of exported file."""
fileType: FileTypesEnum!
}
enum ExportScope {
"""Export all products."""
ALL
"""Export products with given ids."""
IDS
"""Export the filtered products."""
FILTER
}
type ExternalAuthentication {
"""ID of external authentication plugin."""
id: String!
"""Name of external authentication plugin."""
name: String
}
"""Prepare external authentication url for user by custom plugin."""
type ExternalAuthenticationUrl {
"""The data returned by authentication plugin."""
authenticationData: JSONString
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""Logout user by custom plugin."""
type ExternalLogout {
"""The data returned by authentication plugin."""
logoutData: JSONString
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
type ExternalNotificationError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ExternalNotificationErrorCodes!
}
"""An enumeration."""
enum ExternalNotificationErrorCodes {
REQUIRED
INVALID_MODEL_TYPE
NOT_FOUND
CHANNEL_INACTIVE
}
"""
Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload.
Added in Saleor 3.1.
"""
type ExternalNotificationTrigger {
errors: [ExternalNotificationError!]!
}
input ExternalNotificationTriggerInput {
"""
The list of customers or orders node IDs that will be serialized and included in the notification payload.
"""
ids: [ID!]!
"""
Additional payload that will be merged with the one based on the bussines object ID.
"""
extraPayload: JSONString
"""
External event type. This field is passed to a plugin as an event type.
"""
externalEventType: String!
}
"""Obtain external access tokens for user by custom plugin."""
type ExternalObtainAccessTokens {
"""The token, required to authenticate."""
token: String
"""The refresh token, required to re-generate external access token."""
refreshToken: String
"""CSRF token required to re-generate external access token."""
csrfToken: String
"""A user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""Refresh user's access by custom plugin."""
type ExternalRefresh {
"""The token, required to authenticate."""
token: String
"""The refresh token, required to re-generate external access token."""
refreshToken: String
"""CSRF token required to re-generate external access token."""
csrfToken: String
"""A user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""Verify external authentication data by plugin."""
type ExternalVerify {
"""User assigned to data."""
user: User
"""Determine if authentication data is valid or not."""
isValid: Boolean!
"""External data."""
verifyData: JSONString
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
type File {
"""The URL of the file."""
url: String!
"""Content type of the file."""
contentType: String
}
"""An enumeration."""
enum FileTypesEnum {
CSV
XLSX
}
"""
Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
type FileUpload {
uploadedFile: File
uploadErrors: [UploadError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [UploadError!]!
}
"""Represents order fulfillment."""
type Fulfillment implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
fulfillmentOrder: Int!
status: FulfillmentStatus!
trackingNumber: String!
created: DateTime!
"""List of lines for the fulfillment."""
lines: [FulfillmentLine!]
"""User-friendly fulfillment status."""
statusDisplay: String
"""Warehouse from fulfillment was fulfilled."""
warehouse: Warehouse
}
"""
Approve existing fulfillment.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type FulfillmentApprove {
"""An approved fulfillment."""
fulfillment: Fulfillment
"""Order which fulfillment was approved."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Event sent when fulfillment is approved.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type FulfillmentApproved implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The fulfillment the event relates to."""
fulfillment: Fulfillment
"""The order the fulfillment belongs to."""
order: Order
}
"""
Cancels existing fulfillment and optionally restocks items.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type FulfillmentCancel {
"""A canceled fulfillment."""
fulfillment: Fulfillment
"""Order which fulfillment was cancelled."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input FulfillmentCancelInput {
"""
ID of a warehouse where items will be restocked. Optional when fulfillment is in WAITING_FOR_APPROVAL state.
"""
warehouseId: ID
}
"""
Event sent when fulfillment is canceled.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type FulfillmentCanceled implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The fulfillment the event relates to."""
fulfillment: Fulfillment
"""The order the fulfillment belongs to."""
order: Order
}
"""
Event sent when new fulfillment is created.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type FulfillmentCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The fulfillment the event relates to."""
fulfillment: Fulfillment
"""The order the fulfillment belongs to."""
order: Order
}
"""Represents line of the fulfillment."""
type FulfillmentLine implements Node {
id: ID!
quantity: Int!
orderLine: OrderLine
}
"""
Event sent when fulfillment metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type FulfillmentMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The fulfillment the event relates to."""
fulfillment: Fulfillment
"""The order the fulfillment belongs to."""
order: Order
}
"""
Refund products.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type FulfillmentRefundProducts {
"""A refunded fulfillment."""
fulfillment: Fulfillment
"""Order which fulfillment was refunded."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Return products.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type FulfillmentReturnProducts {
"""A return fulfillment."""
returnFulfillment: Fulfillment
"""A replace fulfillment."""
replaceFulfillment: Fulfillment
"""Order which fulfillment was returned."""
order: Order
"""A draft order which was created for products with replace flag."""
replaceOrder: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""An enumeration."""
enum FulfillmentStatus {
FULFILLED
REFUNDED
RETURNED
REPLACED
REFUNDED_AND_RETURNED
CANCELED
WAITING_FOR_APPROVAL
}
"""
Updates a fulfillment for an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type FulfillmentUpdateTracking {
"""A fulfillment with updated tracking."""
fulfillment: Fulfillment
"""Order for which fulfillment was updated."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input FulfillmentUpdateTrackingInput {
"""Fulfillment tracking number."""
trackingNumber: String
"""If true, send an email notification to the customer."""
notifyCustomer: Boolean = false
}
"""Payment gateway client configuration key and value pair."""
type GatewayConfigLine {
"""Gateway config key."""
field: String!
"""Gateway config value for key."""
value: String
}
"""
The `GenericScalar` scalar type represents a generic
GraphQL scalar value that could be:
String, Boolean, Int, Float, List or Object.
"""
scalar GenericScalar
"""
A gift card is a prepaid electronic payment card accepted in stores. They can be used during checkout by providing a valid gift card codes.
"""
type GiftCard implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""Code in format which allows displaying in a user interface."""
displayCode: String!
"""Last 4 characters of gift card code."""
last4CodeChars: String!
"""
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.
"""
code: String!
created: DateTime!
"""
The user who bought or issued a gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
createdBy: User
"""
The customer who used a gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
usedBy: User
"""
Email address of the user who bought or issued gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_USERS, OWNER.
"""
createdByEmail: String
"""
Email address of the customer who used a gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
usedByEmail: String
lastUsedOn: DateTime
expiryDate: Date
"""
App which created the gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_APPS, OWNER.
"""
app: App
"""
Related gift card product.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
product: Product
"""
List of events associated with the gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
events(
"""Filtering options for gift card events."""
filter: GiftCardEventFilterInput
): [GiftCardEvent!]!
"""
The gift card tag.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
tags: [GiftCardTag!]!
"""
Slug of the channel where the gift card was bought.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
boughtInChannel: String
isActive: Boolean!
initialBalance: Money!
currentBalance: Money!
"""The customer who bought a gift card."""
user: User @deprecated(reason: "This field will be removed in Saleor 4.0. Use `createdBy` field instead.")
"""End date of gift card."""
endDate: DateTime @deprecated(reason: "This field will be removed in Saleor 4.0. Use `expiryDate` field instead.")
"""Start date of gift card."""
startDate: DateTime @deprecated(reason: "This field will be removed in Saleor 4.0.")
}
"""
Activate a gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardActivate {
"""Activated gift card."""
giftCard: GiftCard
giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [GiftCardError!]!
}
"""
Adds note to the gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardAddNote {
"""Gift card with the note added."""
giftCard: GiftCard
"""Gift card note created."""
event: GiftCardEvent
errors: [GiftCardError!]!
}
input GiftCardAddNoteInput {
"""Note message."""
message: String!
}
"""
Activate gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardBulkActivate {
"""Returns how many objects were affected."""
count: Int!
errors: [GiftCardError!]!
}
"""
Create gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardBulkCreate {
"""Returns how many objects were created."""
count: Int!
"""List of created gift cards."""
giftCards: [GiftCard!]!
errors: [GiftCardError!]!
}
input GiftCardBulkCreateInput {
"""The number of cards to issue."""
count: Int!
"""Balance of the gift card."""
balance: PriceInput!
"""The gift card tags."""
tags: [String!]
"""The gift card expiry date."""
expiryDate: Date
"""Determine if gift card is active."""
isActive: Boolean!
}
"""
Deactivate gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardBulkDeactivate {
"""Returns how many objects were affected."""
count: Int!
errors: [GiftCardError!]!
}
"""
Delete gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardBulkDelete {
"""Returns how many objects were affected."""
count: Int!
errors: [GiftCardError!]!
}
type GiftCardCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [GiftCardCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type GiftCardCountableEdge {
"""The item at the end of the edge."""
node: GiftCard!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardCreate {
giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [GiftCardError!]!
giftCard: GiftCard
}
input GiftCardCreateInput {
"""
The gift card tags to add.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
addTags: [String!]
"""
The gift card expiry date.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
expiryDate: Date
"""
Start date of the gift card in ISO 8601 format.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
startDate: Date
"""
End date of the gift card in ISO 8601 format.
DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead.
"""
endDate: Date
"""Balance of the gift card."""
balance: PriceInput!
"""Email of the customer to whom gift card will be sent."""
userEmail: String
"""
Slug of a channel from which the email should be sent.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
channel: String
"""
Determine if gift card is active.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
isActive: Boolean!
"""
Code to use the gift card.
DEPRECATED: this field will be removed in Saleor 4.0. The code is now auto generated.
"""
code: String
"""
The gift card note from the staff member.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
note: String
}
"""
Event sent when new gift card is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The gift card the event relates to."""
giftCard: GiftCard
}
"""
Event sent when new gift card is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The gift card the event relates to."""
giftCard: GiftCard
}
"""
Deactivate a gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardDeactivate {
"""Deactivated gift card."""
giftCard: GiftCard
giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [GiftCardError!]!
}
"""
Delete gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardDelete {
giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [GiftCardError!]!
giftCard: GiftCard
}
"""
Event sent when gift card is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The gift card the event relates to."""
giftCard: GiftCard
}
type GiftCardError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: GiftCardErrorCode!
"""List of tag values that cause the error."""
tags: [String!]
}
"""An enumeration."""
enum GiftCardErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
EXPIRED_GIFT_CARD
DUPLICATED_INPUT_ITEM
}
"""
History log of the gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardEvent implements Node {
id: ID!
"""Date when event happened at in ISO 8601 format."""
date: DateTime
"""Gift card event type."""
type: GiftCardEventsEnum
"""
User who performed the action. Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER.
"""
user: User
"""
App that performed the action. Requires one of the following permissions: MANAGE_APPS, OWNER.
"""
app: App
"""Content of the event."""
message: String
"""Email of the customer."""
email: String
"""The order ID where gift card was used or bought."""
orderId: ID
"""User-friendly number of an order where gift card was used or bought."""
orderNumber: String
"""The list of gift card tags."""
tags: [String!]
"""The list of old gift card tags."""
oldTags: [String!]
"""The gift card balance."""
balance: GiftCardEventBalance
"""The gift card expiry date."""
expiryDate: Date
"""Previous gift card expiry date."""
oldExpiryDate: Date
}
type GiftCardEventBalance {
"""Initial balance of the gift card."""
initialBalance: Money
"""Current balance of the gift card."""
currentBalance: Money!
"""Previous initial balance of the gift card."""
oldInitialBalance: Money
"""Previous current balance of the gift card."""
oldCurrentBalance: Money
}
input GiftCardEventFilterInput {
type: GiftCardEventsEnum
orders: [ID!]
}
"""An enumeration."""
enum GiftCardEventsEnum {
ISSUED
BOUGHT
UPDATED
ACTIVATED
DEACTIVATED
BALANCE_RESET
EXPIRY_DATE_UPDATED
TAGS_UPDATED
SENT_TO_CUSTOMER
RESENT
NOTE_ADDED
USED_IN_ORDER
}
input GiftCardFilterInput {
isActive: Boolean
metadata: [MetadataFilter!]
tags: [String!]
products: [ID!]
usedBy: [ID!]
used: Boolean
currency: String
currentBalance: PriceRangeInput
initialBalance: PriceRangeInput
code: String
}
"""
Event sent when gift card metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The gift card the event relates to."""
giftCard: GiftCard
}
"""
Resend a gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardResend {
"""Gift card which has been sent."""
giftCard: GiftCard
errors: [GiftCardError!]!
}
input GiftCardResendInput {
"""ID of a gift card to resend."""
id: ID!
"""Email to which gift card should be send."""
email: String
"""Slug of a channel from which the email should be sent."""
channel: String!
}
"""Gift card related settings from site settings."""
type GiftCardSettings {
"""The gift card expiry type settings."""
expiryType: GiftCardSettingsExpiryTypeEnum!
"""The gift card expiry period settings."""
expiryPeriod: TimePeriod
}
type GiftCardSettingsError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: GiftCardSettingsErrorCode!
}
"""An enumeration."""
enum GiftCardSettingsErrorCode {
INVALID
REQUIRED
GRAPHQL_ERROR
}
"""An enumeration."""
enum GiftCardSettingsExpiryTypeEnum {
NEVER_EXPIRE
EXPIRY_PERIOD
}
"""
Update gift card settings.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardSettingsUpdate {
"""Gift card settings."""
giftCardSettings: GiftCardSettings
errors: [GiftCardSettingsError!]!
}
input GiftCardSettingsUpdateInput {
"""Defines gift card default expiry settings."""
expiryType: GiftCardSettingsExpiryTypeEnum
"""Defines gift card expiry period."""
expiryPeriod: TimePeriodInputType
}
enum GiftCardSortField {
"""Sort gift cards by product."""
PRODUCT
"""Sort gift cards by used by."""
USED_BY
"""Sort gift cards by current balance."""
CURRENT_BALANCE
"""
Sort gift cards by created at.
Added in Saleor 3.8.
"""
CREATED_AT
}
input GiftCardSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort gift cards by the selected field."""
field: GiftCardSortField!
}
"""
Event sent when gift card status has changed.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardStatusChanged implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The gift card the event relates to."""
giftCard: GiftCard
}
"""
The gift card tag.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardTag implements Node {
id: ID!
name: String!
}
type GiftCardTagCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [GiftCardTagCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type GiftCardTagCountableEdge {
"""The item at the end of the edge."""
node: GiftCardTag!
"""A cursor for use in pagination."""
cursor: String!
}
input GiftCardTagFilterInput {
search: String
}
"""
Update a gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
type GiftCardUpdate {
giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [GiftCardError!]!
giftCard: GiftCard
}
input GiftCardUpdateInput {
"""
The gift card tags to add.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
addTags: [String!]
"""
The gift card expiry date.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
expiryDate: Date
"""
Start date of the gift card in ISO 8601 format.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
startDate: Date
"""
End date of the gift card in ISO 8601 format.
DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead.
"""
endDate: Date
"""
The gift card tags to remove.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
removeTags: [String!]
"""
The gift card balance amount.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
balanceAmount: PositiveDecimal
}
"""
Event sent when gift card is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type GiftCardUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The gift card the event relates to."""
giftCard: GiftCard
}
"""Represents permission group data."""
type Group implements Node {
id: ID!
name: String!
"""
List of group users
Requires one of the following permissions: MANAGE_STAFF.
"""
users: [User!]
"""List of group permissions"""
permissions: [Permission!]
"""
True, if the currently authenticated user has rights to manage a group.
"""
userCanManage: Boolean!
}
type GroupCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [GroupCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type GroupCountableEdge {
"""The item at the end of the edge."""
node: Group!
"""A cursor for use in pagination."""
cursor: String!
}
"""Represents an image."""
type Image {
"""The URL of the image."""
url: String!
"""Alt text for an image."""
alt: String
}
input IntRangeInput {
"""Value greater than or equal to."""
gte: Int
"""Value less than or equal to."""
lte: Int
}
"""Represents an Invoice."""
type Invoice implements ObjectWithMetadata & Job & Node {
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""Job status."""
status: JobStatusEnum!
createdAt: DateTime!
updatedAt: DateTime!
message: String
"""The ID of the object."""
id: ID!
number: String
externalUrl: String
"""URL to download an invoice."""
url: String
}
"""
Creates a ready to send invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type InvoiceCreate {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
input InvoiceCreateInput {
"""Invoice number."""
number: String!
"""URL of an invoice to download."""
url: String!
}
"""
Deletes an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type InvoiceDelete {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
"""
Event sent when invoice is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type InvoiceDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The invoice the event relates to."""
invoice: Invoice
}
type InvoiceError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: InvoiceErrorCode!
}
"""An enumeration."""
enum InvoiceErrorCode {
REQUIRED
NOT_READY
URL_NOT_SET
EMAIL_NOT_SET
NUMBER_NOT_SET
NOT_FOUND
INVALID_STATUS
NO_INVOICE_PLUGIN
}
"""
Request an invoice for the order using plugin.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type InvoiceRequest {
"""Order related to an invoice."""
order: Order
invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
"""
Requests deletion of an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type InvoiceRequestDelete {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
"""
Event sent when invoice is requested.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type InvoiceRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The invoice the event relates to."""
invoice: Invoice
}
"""
Send an invoice notification to the customer.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type InvoiceSendNotification {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
"""
Event sent when invoice is sent.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type InvoiceSent implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The invoice the event relates to."""
invoice: Invoice
}
"""
Updates an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type InvoiceUpdate {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
union IssuingPrincipal = App | User
scalar JSONString
interface Job {
"""Job status."""
status: JobStatusEnum!
"""Created date time of job in ISO 8601 format."""
createdAt: DateTime!
"""Date time of job last update in ISO 8601 format."""
updatedAt: DateTime!
"""Job message."""
message: String
}
"""An enumeration."""
enum JobStatusEnum {
PENDING
SUCCESS
FAILED
DELETED
}
"""An enumeration."""
enum LanguageCodeEnum {
AF
AF_NA
AF_ZA
AGQ
AGQ_CM
AK
AK_GH
AM
AM_ET
AR
AR_AE
AR_BH
AR_DJ
AR_DZ
AR_EG
AR_EH
AR_ER
AR_IL
AR_IQ
AR_JO
AR_KM
AR_KW
AR_LB
AR_LY
AR_MA
AR_MR
AR_OM
AR_PS
AR_QA
AR_SA
AR_SD
AR_SO
AR_SS
AR_SY
AR_TD
AR_TN
AR_YE
AS
AS_IN
ASA
ASA_TZ
AST
AST_ES
AZ
AZ_CYRL
AZ_CYRL_AZ
AZ_LATN
AZ_LATN_AZ
BAS
BAS_CM
BE
BE_BY
BEM
BEM_ZM
BEZ
BEZ_TZ
BG
BG_BG
BM
BM_ML
BN
BN_BD
BN_IN
BO
BO_CN
BO_IN
BR
BR_FR
BRX
BRX_IN
BS
BS_CYRL
BS_CYRL_BA
BS_LATN
BS_LATN_BA
CA
CA_AD
CA_ES
CA_ES_VALENCIA
CA_FR
CA_IT
CCP
CCP_BD
CCP_IN
CE
CE_RU
CEB
CEB_PH
CGG
CGG_UG
CHR
CHR_US
CKB
CKB_IQ
CKB_IR
CS
CS_CZ
CU
CU_RU
CY
CY_GB
DA
DA_DK
DA_GL
DAV
DAV_KE
DE
DE_AT
DE_BE
DE_CH
DE_DE
DE_IT
DE_LI
DE_LU
DJE
DJE_NE
DSB
DSB_DE
DUA
DUA_CM
DYO
DYO_SN
DZ
DZ_BT
EBU
EBU_KE
EE
EE_GH
EE_TG
EL
EL_CY
EL_GR
EN
EN_AE
EN_AG
EN_AI
EN_AS
EN_AT
EN_AU
EN_BB
EN_BE
EN_BI
EN_BM
EN_BS
EN_BW
EN_BZ
EN_CA
EN_CC
EN_CH
EN_CK
EN_CM
EN_CX
EN_CY
EN_DE
EN_DG
EN_DK
EN_DM
EN_ER
EN_FI
EN_FJ
EN_FK
EN_FM
EN_GB
EN_GD
EN_GG
EN_GH
EN_GI
EN_GM
EN_GU
EN_GY
EN_HK
EN_IE
EN_IL
EN_IM
EN_IN
EN_IO
EN_JE
EN_JM
EN_KE
EN_KI
EN_KN
EN_KY
EN_LC
EN_LR
EN_LS
EN_MG
EN_MH
EN_MO
EN_MP
EN_MS
EN_MT
EN_MU
EN_MW
EN_MY
EN_NA
EN_NF
EN_NG
EN_NL
EN_NR
EN_NU
EN_NZ
EN_PG
EN_PH
EN_PK
EN_PN
EN_PR
EN_PW
EN_RW
EN_SB
EN_SC
EN_SD
EN_SE
EN_SG
EN_SH
EN_SI
EN_SL
EN_SS
EN_SX
EN_SZ
EN_TC
EN_TK
EN_TO
EN_TT
EN_TV
EN_TZ
EN_UG
EN_UM
EN_US
EN_VC
EN_VG
EN_VI
EN_VU
EN_WS
EN_ZA
EN_ZM
EN_ZW
EO
ES
ES_AR
ES_BO
ES_BR
ES_BZ
ES_CL
ES_CO
ES_CR
ES_CU
ES_DO
ES_EA
ES_EC
ES_ES
ES_GQ
ES_GT
ES_HN
ES_IC
ES_MX
ES_NI
ES_PA
ES_PE
ES_PH
ES_PR
ES_PY
ES_SV
ES_US
ES_UY
ES_VE
ET
ET_EE
EU
EU_ES
EWO
EWO_CM
FA
FA_AF
FA_IR
FF
FF_ADLM
FF_ADLM_BF
FF_ADLM_CM
FF_ADLM_GH
FF_ADLM_GM
FF_ADLM_GN
FF_ADLM_GW
FF_ADLM_LR
FF_ADLM_MR
FF_ADLM_NE
FF_ADLM_NG
FF_ADLM_SL
FF_ADLM_SN
FF_LATN
FF_LATN_BF
FF_LATN_CM
FF_LATN_GH
FF_LATN_GM
FF_LATN_GN
FF_LATN_GW
FF_LATN_LR
FF_LATN_MR
FF_LATN_NE
FF_LATN_NG
FF_LATN_SL
FF_LATN_SN
FI
FI_FI
FIL
FIL_PH
FO
FO_DK
FO_FO
FR
FR_BE
FR_BF
FR_BI
FR_BJ
FR_BL
FR_CA
FR_CD
FR_CF
FR_CG
FR_CH
FR_CI
FR_CM
FR_DJ
FR_DZ
FR_FR
FR_GA
FR_GF
FR_GN
FR_GP
FR_GQ
FR_HT
FR_KM
FR_LU
FR_MA
FR_MC
FR_MF
FR_MG
FR_ML
FR_MQ
FR_MR
FR_MU
FR_NC
FR_NE
FR_PF
FR_PM
FR_RE
FR_RW
FR_SC
FR_SN
FR_SY
FR_TD
FR_TG
FR_TN
FR_VU
FR_WF
FR_YT
FUR
FUR_IT
FY
FY_NL
GA
GA_GB
GA_IE
GD
GD_GB
GL
GL_ES
GSW
GSW_CH
GSW_FR
GSW_LI
GU
GU_IN
GUZ
GUZ_KE
GV
GV_IM
HA
HA_GH
HA_NE
HA_NG
HAW
HAW_US
HE
HE_IL
HI
HI_IN
HR
HR_BA
HR_HR
HSB
HSB_DE
HU
HU_HU
HY
HY_AM
IA
ID
ID_ID
IG
IG_NG
II
II_CN
IS
IS_IS
IT
IT_CH
IT_IT
IT_SM
IT_VA
JA
JA_JP
JGO
JGO_CM
JMC
JMC_TZ
JV
JV_ID
KA
KA_GE
KAB
KAB_DZ
KAM
KAM_KE
KDE
KDE_TZ
KEA
KEA_CV
KHQ
KHQ_ML
KI
KI_KE
KK
KK_KZ
KKJ
KKJ_CM
KL
KL_GL
KLN
KLN_KE
KM
KM_KH
KN
KN_IN
KO
KO_KP
KO_KR
KOK
KOK_IN
KS
KS_ARAB
KS_ARAB_IN
KSB
KSB_TZ
KSF
KSF_CM
KSH
KSH_DE
KU
KU_TR
KW
KW_GB
KY
KY_KG
LAG
LAG_TZ
LB
LB_LU
LG
LG_UG
LKT
LKT_US
LN
LN_AO
LN_CD
LN_CF
LN_CG
LO
LO_LA
LRC
LRC_IQ
LRC_IR
LT
LT_LT
LU
LU_CD
LUO
LUO_KE
LUY
LUY_KE
LV
LV_LV
MAI
MAI_IN
MAS
MAS_KE
MAS_TZ
MER
MER_KE
MFE
MFE_MU
MG
MG_MG
MGH
MGH_MZ
MGO
MGO_CM
MI
MI_NZ
MK
MK_MK
ML
ML_IN
MN
MN_MN
MNI
MNI_BENG
MNI_BENG_IN
MR
MR_IN
MS
MS_BN
MS_ID
MS_MY
MS_SG
MT
MT_MT
MUA
MUA_CM
MY
MY_MM
MZN
MZN_IR
NAQ
NAQ_NA
NB
NB_NO
NB_SJ
ND
ND_ZW
NDS
NDS_DE
NDS_NL
NE
NE_IN
NE_NP
NL
NL_AW
NL_BE
NL_BQ
NL_CW
NL_NL
NL_SR
NL_SX
NMG
NMG_CM
NN
NN_NO
NNH
NNH_CM
NUS
NUS_SS
NYN
NYN_UG
OM
OM_ET
OM_KE
OR
OR_IN
OS
OS_GE
OS_RU
PA
PA_ARAB
PA_ARAB_PK
PA_GURU
PA_GURU_IN
PCM
PCM_NG
PL
PL_PL
PRG
PS
PS_AF
PS_PK
PT
PT_AO
PT_BR
PT_CH
PT_CV
PT_GQ
PT_GW
PT_LU
PT_MO
PT_MZ
PT_PT
PT_ST
PT_TL
QU
QU_BO
QU_EC
QU_PE
RM
RM_CH
RN
RN_BI
RO
RO_MD
RO_RO
ROF
ROF_TZ
RU
RU_BY
RU_KG
RU_KZ
RU_MD
RU_RU
RU_UA
RW
RW_RW
RWK
RWK_TZ
SAH
SAH_RU
SAQ
SAQ_KE
SAT
SAT_OLCK
SAT_OLCK_IN
SBP
SBP_TZ
SD
SD_ARAB
SD_ARAB_PK
SD_DEVA
SD_DEVA_IN
SE
SE_FI
SE_NO
SE_SE
SEH
SEH_MZ
SES
SES_ML
SG
SG_CF
SHI
SHI_LATN
SHI_LATN_MA
SHI_TFNG
SHI_TFNG_MA
SI
SI_LK
SK
SK_SK
SL
SL_SI
SMN
SMN_FI
SN
SN_ZW
SO
SO_DJ
SO_ET
SO_KE
SO_SO
SQ
SQ_AL
SQ_MK
SQ_XK
SR
SR_CYRL
SR_CYRL_BA
SR_CYRL_ME
SR_CYRL_RS
SR_CYRL_XK
SR_LATN
SR_LATN_BA
SR_LATN_ME
SR_LATN_RS
SR_LATN_XK
SU
SU_LATN
SU_LATN_ID
SV
SV_AX
SV_FI
SV_SE
SW
SW_CD
SW_KE
SW_TZ
SW_UG
TA
TA_IN
TA_LK
TA_MY
TA_SG
TE
TE_IN
TEO
TEO_KE
TEO_UG
TG
TG_TJ
TH
TH_TH
TI
TI_ER
TI_ET
TK
TK_TM
TO
TO_TO
TR
TR_CY
TR_TR
TT
TT_RU
TWQ
TWQ_NE
TZM
TZM_MA
UG
UG_CN
UK
UK_UA
UR
UR_IN
UR_PK
UZ
UZ_ARAB
UZ_ARAB_AF
UZ_CYRL
UZ_CYRL_UZ
UZ_LATN
UZ_LATN_UZ
VAI
VAI_LATN
VAI_LATN_LR
VAI_VAII
VAI_VAII_LR
VI
VI_VN
VO
VUN
VUN_TZ
WAE
WAE_CH
WO
WO_SN
XH
XH_ZA
XOG
XOG_UG
YAV
YAV_CM
YI
YO
YO_BJ
YO_NG
YUE
YUE_HANS
YUE_HANS_CN
YUE_HANT
YUE_HANT_HK
ZGH
ZGH_MA
ZH
ZH_HANS
ZH_HANS_CN
ZH_HANS_HK
ZH_HANS_MO
ZH_HANS_SG
ZH_HANT
ZH_HANT_HK
ZH_HANT_MO
ZH_HANT_TW
ZU
ZU_ZA
}
type LanguageDisplay {
"""ISO 639 representation of the language name."""
code: LanguageCodeEnum!
"""Full name of the language."""
language: String!
}
type LimitInfo {
"""Defines the current resource usage."""
currentUsage: Limits!
"""Defines the allowed maximum resource usage, null means unlimited."""
allowedUsage: Limits!
}
type Limits {
channels: Int
orders: Int
productVariants: Int
staffUsers: Int
warehouses: Int
}
"""The manifest definition."""
type Manifest {
identifier: String!
version: String!
name: String!
about: String
permissions: [Permission!]
appUrl: String
"""URL to iframe with the configuration for the app."""
configurationUrl: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `appUrl` instead.")
tokenTargetUrl: String
"""Description of the data privacy defined for this app."""
dataPrivacy: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead.")
dataPrivacyUrl: String
homepageUrl: String
supportUrl: String
extensions: [AppManifestExtension!]!
"""
List of the app's webhooks.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
webhooks: [AppManifestWebhook!]!
"""
The audience that will be included in all JWT tokens for the app.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
audience: String
}
type Margin {
start: Int
stop: Int
}
"""An enumeration."""
enum MeasurementUnitsEnum {
CM
M
KM
FT
YD
INCH
SQ_CM
SQ_M
SQ_KM
SQ_FT
SQ_YD
SQ_INCH
CUBIC_MILLIMETER
CUBIC_CENTIMETER
CUBIC_DECIMETER
CUBIC_METER
LITER
CUBIC_FOOT
CUBIC_INCH
CUBIC_YARD
QT
PINT
FL_OZ
ACRE_IN
ACRE_FT
G
LB
OZ
KG
TONNE
}
"""
Represents a single menu - an object that is used to help navigate through the store.
"""
type Menu implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
slug: String!
items: [MenuItem!]
}
"""
Deletes menus.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuBulkDelete {
"""Returns how many objects were affected."""
count: Int!
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
}
type MenuCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [MenuCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type MenuCountableEdge {
"""The item at the end of the edge."""
node: Menu!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new Menu.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuCreate {
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
menu: Menu
}
input MenuCreateInput {
"""Name of the menu."""
name: String!
"""Slug of the menu. Will be generated if not provided."""
slug: String
"""List of menu items."""
items: [MenuItemInput!]
}
"""
Event sent when new menu is created.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type MenuCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The menu the event relates to."""
menu(
"""Slug of a channel for which the data should be returned."""
channel: String
): Menu
}
"""
Deletes a menu.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuDelete {
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
menu: Menu
}
"""
Event sent when menu is deleted.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type MenuDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The menu the event relates to."""
menu(
"""Slug of a channel for which the data should be returned."""
channel: String
): Menu
}
type MenuError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: MenuErrorCode!
}
"""An enumeration."""
enum MenuErrorCode {
CANNOT_ASSIGN_NODE
GRAPHQL_ERROR
INVALID
INVALID_MENU_ITEM
NO_MENU_ITEM_PROVIDED
NOT_FOUND
REQUIRED
TOO_MANY_MENU_ITEMS
UNIQUE
}
input MenuFilterInput {
search: String
slug: [String!]
metadata: [MetadataFilter!]
slugs: [String!]
}
input MenuInput {
"""Name of the menu."""
name: String
"""Slug of the menu."""
slug: String
}
"""
Represents a single item of the related menu. Can store categories, collection or pages.
"""
type MenuItem implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
menu: Menu!
parent: MenuItem
category: Category
"""
A collection associated with this menu item. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
collection: Collection
"""
A page associated with this menu item. Requires one of the following permissions to include unpublished items: MANAGE_PAGES.
"""
page: Page
level: Int!
children: [MenuItem!]
"""URL to the menu item."""
url: String
"""Returns translated menu item fields for the given language code."""
translation(
"""A language code to return the translation for menu item."""
languageCode: LanguageCodeEnum!
): MenuItemTranslation
}
"""
Deletes menu items.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuItemBulkDelete {
"""Returns how many objects were affected."""
count: Int!
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
}
type MenuItemCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [MenuItemCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type MenuItemCountableEdge {
"""The item at the end of the edge."""
node: MenuItem!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new menu item.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuItemCreate {
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
menuItem: MenuItem
}
input MenuItemCreateInput {
"""Name of the menu item."""
name: String!
"""URL of the pointed item."""
url: String
"""Category to which item points."""
category: ID
"""Collection to which item points."""
collection: ID
"""Page to which item points."""
page: ID
"""Menu to which item belongs."""
menu: ID!
"""ID of the parent menu. If empty, menu will be top level menu."""
parent: ID
}
"""
Event sent when new menu item is created.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type MenuItemCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The menu item the event relates to."""
menuItem(
"""Slug of a channel for which the data should be returned."""
channel: String
): MenuItem
}
"""
Deletes a menu item.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuItemDelete {
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
menuItem: MenuItem
}
"""
Event sent when menu item is deleted.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type MenuItemDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The menu item the event relates to."""
menuItem(
"""Slug of a channel for which the data should be returned."""
channel: String
): MenuItem
}
input MenuItemFilterInput {
search: String
metadata: [MetadataFilter!]
}
input MenuItemInput {
"""Name of the menu item."""
name: String
"""URL of the pointed item."""
url: String
"""Category to which item points."""
category: ID
"""Collection to which item points."""
collection: ID
"""Page to which item points."""
page: ID
}
"""
Moves items of menus.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuItemMove {
"""Assigned menu to move within."""
menu: Menu
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
}
input MenuItemMoveInput {
"""The menu item ID to move."""
itemId: ID!
"""ID of the parent menu. If empty, menu will be top level menu."""
parentId: ID
"""
The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
"""
sortOrder: Int
}
input MenuItemSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort menu items by the selected field."""
field: MenuItemsSortField!
}
type MenuItemTranslatableContent implements Node {
id: ID!
name: String!
"""Returns translated menu item fields for the given language code."""
translation(
"""A language code to return the translation for menu item."""
languageCode: LanguageCodeEnum!
): MenuItemTranslation
"""
Represents a single item of the related menu. Can store categories, collection or pages.
"""
menuItem: MenuItem @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
}
"""
Creates/updates translations for a menu item.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type MenuItemTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
menuItem: MenuItem
}
type MenuItemTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
name: String!
}
"""
Updates a menu item.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuItemUpdate {
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
menuItem: MenuItem
}
"""
Event sent when menu item is updated.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type MenuItemUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The menu item the event relates to."""
menuItem(
"""Slug of a channel for which the data should be returned."""
channel: String
): MenuItem
}
enum MenuItemsSortField {
"""Sort menu items by name."""
NAME
}
enum MenuSortField {
"""Sort menus by name."""
NAME
"""Sort menus by items count."""
ITEMS_COUNT
}
input MenuSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort menus by the selected field."""
field: MenuSortField!
}
"""
Updates a menu.
Requires one of the following permissions: MANAGE_MENUS.
"""
type MenuUpdate {
menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MenuError!]!
menu: Menu
}
"""
Event sent when menu is updated.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type MenuUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The menu the event relates to."""
menu(
"""Slug of a channel for which the data should be returned."""
channel: String
): Menu
}
"""
Metadata is a map of key-value pairs, both keys and values are `String`.
Example:
```
{
"key1": "value1",
"key2": "value2"
}
```
"""
scalar Metadata
type MetadataError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: MetadataErrorCode!
}
"""An enumeration."""
enum MetadataErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
NOT_UPDATED
}
input MetadataFilter {
"""Key of a metadata item."""
key: String!
"""Value of a metadata item."""
value: String
}
input MetadataInput {
"""Key of a metadata item."""
key: String!
"""Value of a metadata item."""
value: String!
}
type MetadataItem {
"""Key of a metadata item."""
key: String!
"""Value of a metadata item."""
value: String!
}
"""Represents amount of money in specific currency."""
type Money {
"""Currency code."""
currency: String!
"""Amount of money."""
amount: Float!
}
input MoneyInput {
"""Currency code."""
currency: String!
"""Amount of money."""
amount: PositiveDecimal!
}
"""Represents a range of amounts of money."""
type MoneyRange {
"""Lower bound of a price range."""
start: Money
"""Upper bound of a price range."""
stop: Money
}
input MoveProductInput {
"""The ID of the product to move."""
productId: ID!
"""
The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
"""
sortOrder: Int
}
type Mutation {
"""
Creates a new webhook subscription.
Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
"""
webhookCreate(
"""Fields required to create a webhook."""
input: WebhookCreateInput!
): WebhookCreate
"""
Deletes a webhook subscription.
Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
"""
webhookDelete(
"""ID of a webhook to delete."""
id: ID!
): WebhookDelete
"""
Updates a webhook subscription.
Requires one of the following permissions: MANAGE_APPS.
"""
webhookUpdate(
"""ID of a webhook to update."""
id: ID!
"""Fields required to update a webhook."""
input: WebhookUpdateInput!
): WebhookUpdate
"""
Retries event delivery.
Requires one of the following permissions: MANAGE_APPS.
"""
eventDeliveryRetry(
"""ID of the event delivery to retry."""
id: ID!
): EventDeliveryRetry
"""
Creates new warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
createWarehouse(
"""Fields required to create warehouse."""
input: WarehouseCreateInput!
): WarehouseCreate
"""
Updates given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
updateWarehouse(
"""ID of a warehouse to update."""
id: ID!
"""Fields required to update warehouse."""
input: WarehouseUpdateInput!
): WarehouseUpdate
"""
Deletes selected warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
deleteWarehouse(
"""ID of a warehouse to delete."""
id: ID!
): WarehouseDelete
"""
Add shipping zone to given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
assignWarehouseShippingZone(
"""ID of a warehouse to update."""
id: ID!
"""List of shipping zone IDs."""
shippingZoneIds: [ID!]!
): WarehouseShippingZoneAssign
"""
Remove shipping zone from given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
unassignWarehouseShippingZone(
"""ID of a warehouse to update."""
id: ID!
"""List of shipping zone IDs."""
shippingZoneIds: [ID!]!
): WarehouseShippingZoneUnassign
"""
Create a tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
taxClassCreate(
"""Fields required to create a tax class."""
input: TaxClassCreateInput!
): TaxClassCreate
"""
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.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
taxClassDelete(
"""ID of a tax class to delete."""
id: ID!
): TaxClassDelete
"""
Update a tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
taxClassUpdate(
"""ID of the tax class."""
id: ID!
"""Fields required to update a tax class."""
input: TaxClassUpdateInput!
): TaxClassUpdate
"""
Update tax configuration for a channel.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
taxConfigurationUpdate(
"""ID of the tax configuration."""
id: ID!
"""Fields required to update the tax configuration."""
input: TaxConfigurationUpdateInput!
): TaxConfigurationUpdate
"""
Update tax class rates for a specific country.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
taxCountryConfigurationUpdate(
"""Country in which to update the tax class rates."""
countryCode: CountryCode!
"""
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.
"""
updateTaxClassRates: [TaxClassRateInput!]!
): TaxCountryConfigurationUpdate
"""
Remove all tax class rates for a specific country.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
taxCountryConfigurationDelete(
"""Country in which to update the tax class rates."""
countryCode: CountryCode!
): TaxCountryConfigurationDelete
"""
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.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
taxExemptionManage(
"""ID of the Checkout or Order object."""
id: ID!
"""Determines if a taxes should be exempt."""
taxExemption: Boolean!
): TaxExemptionManage
"""
Creates a new staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
staffNotificationRecipientCreate(
"""Fields required to create a staff notification recipient."""
input: StaffNotificationRecipientInput!
): StaffNotificationRecipientCreate
"""
Updates a staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
staffNotificationRecipientUpdate(
"""ID of a staff notification recipient to update."""
id: ID!
"""Fields required to update a staff notification recipient."""
input: StaffNotificationRecipientInput!
): StaffNotificationRecipientUpdate
"""
Delete staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
staffNotificationRecipientDelete(
"""ID of a staff notification recipient to delete."""
id: ID!
): StaffNotificationRecipientDelete
"""
Updates site domain of the shop.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
shopDomainUpdate(
"""Fields required to update site."""
input: SiteDomainInput
): ShopDomainUpdate
"""
Updates shop settings.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
shopSettingsUpdate(
"""Fields required to update shop settings."""
input: ShopSettingsInput!
): ShopSettingsUpdate
"""
Fetch tax rates.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
shopFetchTaxRates: ShopFetchTaxRates @deprecated(reason: "\n\nDEPRECATED: this mutation will be removed in Saleor 4.0.")
"""
Creates/updates translations for shop settings.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
shopSettingsTranslate(
"""Fields required to update shop settings translations."""
input: ShopSettingsTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): ShopSettingsTranslate
"""
Update the shop's address. If the `null` value is passed, the currently selected address will be deleted.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
shopAddressUpdate(
"""Fields required to update shop address."""
input: AddressInput
): ShopAddressUpdate
"""
Update shop order settings.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderSettingsUpdate(
"""Fields required to update shop order settings."""
input: OrderSettingsUpdateInput!
): OrderSettingsUpdate
"""
Update gift card settings.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardSettingsUpdate(
"""Fields required to update gift card settings."""
input: GiftCardSettingsUpdateInput!
): GiftCardSettingsUpdate
"""
Manage shipping method's availability in channels.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingMethodChannelListingUpdate(
"""ID of a shipping method to update."""
id: ID!
"""Fields required to update shipping method channel listings."""
input: ShippingMethodChannelListingInput!
): ShippingMethodChannelListingUpdate
"""
Creates a new shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingPriceCreate(
"""Fields required to create a shipping price."""
input: ShippingPriceInput!
): ShippingPriceCreate
"""
Deletes a shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingPriceDelete(
"""ID of a shipping price to delete."""
id: ID!
): ShippingPriceDelete
"""
Deletes shipping prices.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingPriceBulkDelete(
"""List of shipping price IDs to delete."""
ids: [ID!]!
): ShippingPriceBulkDelete
"""
Updates a new shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingPriceUpdate(
"""ID of a shipping price to update."""
id: ID!
"""Fields required to update a shipping price."""
input: ShippingPriceInput!
): ShippingPriceUpdate
"""
Creates/updates translations for a shipping method.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
shippingPriceTranslate(
"""ShippingMethodType ID or ShippingMethodTranslatableContent ID."""
id: ID!
input: ShippingPriceTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): ShippingPriceTranslate
"""
Exclude products from shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingPriceExcludeProducts(
"""ID of a shipping price."""
id: ID!
"""Exclude products input."""
input: ShippingPriceExcludeProductsInput!
): ShippingPriceExcludeProducts
"""
Remove product from excluded list for shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingPriceRemoveProductFromExclude(
"""ID of a shipping price."""
id: ID!
"""List of products which will be removed from excluded list."""
products: [ID!]!
): ShippingPriceRemoveProductFromExclude
"""
Creates a new shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingZoneCreate(
"""Fields required to create a shipping zone."""
input: ShippingZoneCreateInput!
): ShippingZoneCreate
"""
Deletes a shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingZoneDelete(
"""ID of a shipping zone to delete."""
id: ID!
): ShippingZoneDelete
"""
Deletes shipping zones.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingZoneBulkDelete(
"""List of shipping zone IDs to delete."""
ids: [ID!]!
): ShippingZoneBulkDelete
"""
Updates a new shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingZoneUpdate(
"""ID of a shipping zone to update."""
id: ID!
"""Fields required to update a shipping zone."""
input: ShippingZoneUpdateInput!
): ShippingZoneUpdate
"""
Assign attributes to a given product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productAttributeAssign(
"""The operations to perform."""
operations: [ProductAttributeAssignInput!]!
"""ID of the product type to assign the attributes into."""
productTypeId: ID!
): ProductAttributeAssign
"""
Update attributes assigned to product variant for given product type.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productAttributeAssignmentUpdate(
"""The operations to perform."""
operations: [ProductAttributeAssignmentUpdateInput!]!
"""ID of the product type to assign the attributes into."""
productTypeId: ID!
): ProductAttributeAssignmentUpdate
"""
Un-assign attributes from a given product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productAttributeUnassign(
"""The IDs of the attributes to unassign."""
attributeIds: [ID!]!
"""ID of the product type from which the attributes should be unassigned."""
productTypeId: ID!
): ProductAttributeUnassign
"""
Creates a new category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
categoryCreate(
"""Fields required to create a category."""
input: CategoryInput!
"""
ID of the parent category. If empty, category will be top level category.
"""
parent: ID
): CategoryCreate
"""
Deletes a category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
categoryDelete(
"""ID of a category to delete."""
id: ID!
): CategoryDelete
"""
Deletes categories.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
categoryBulkDelete(
"""List of category IDs to delete."""
ids: [ID!]!
): CategoryBulkDelete
"""
Updates a category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
categoryUpdate(
"""ID of a category to update."""
id: ID!
"""Fields required to update a category."""
input: CategoryInput!
): CategoryUpdate
"""
Creates/updates translations for a category.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
categoryTranslate(
"""Category ID or CategoryTranslatableContent ID."""
id: ID!
input: TranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): CategoryTranslate
"""
Adds products to a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionAddProducts(
"""ID of a collection."""
collectionId: ID!
"""List of product IDs."""
products: [ID!]!
): CollectionAddProducts
"""
Creates a new collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionCreate(
"""Fields required to create a collection."""
input: CollectionCreateInput!
): CollectionCreate
"""
Deletes a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionDelete(
"""ID of a collection to delete."""
id: ID!
): CollectionDelete
"""
Reorder the products of a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionReorderProducts(
"""ID of a collection."""
collectionId: ID!
"""The collection products position operations."""
moves: [MoveProductInput!]!
): CollectionReorderProducts
"""
Deletes collections.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionBulkDelete(
"""List of collection IDs to delete."""
ids: [ID!]!
): CollectionBulkDelete
"""
Remove products from a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionRemoveProducts(
"""ID of a collection."""
collectionId: ID!
"""List of product IDs."""
products: [ID!]!
): CollectionRemoveProducts
"""
Updates a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionUpdate(
"""ID of a collection to update."""
id: ID!
"""Fields required to update a collection."""
input: CollectionInput!
): CollectionUpdate
"""
Creates/updates translations for a collection.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
collectionTranslate(
"""Collection ID or CollectionTranslatableContent ID."""
id: ID!
input: TranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): CollectionTranslate
"""
Manage collection's availability in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
collectionChannelListingUpdate(
"""ID of a collection to update."""
id: ID!
"""Fields required to create or update collection channel listings."""
input: CollectionChannelListingUpdateInput!
): CollectionChannelListingUpdate
"""
Creates a new product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productCreate(
"""Fields required to create a product."""
input: ProductCreateInput!
): ProductCreate
"""
Deletes a product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productDelete(
"""ID of a product to delete."""
id: ID!
): ProductDelete
"""
Deletes products.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productBulkDelete(
"""List of product IDs to delete."""
ids: [ID!]!
): ProductBulkDelete
"""
Updates an existing product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productUpdate(
"""ID of a product to update."""
id: ID!
"""Fields required to update a product."""
input: ProductInput!
): ProductUpdate
"""
Creates/updates translations for a product.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
productTranslate(
"""Product ID or ProductTranslatableContent ID."""
id: ID!
input: TranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): ProductTranslate
"""
Manage product's availability in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productChannelListingUpdate(
"""ID of a product to update."""
id: ID!
"""Fields required to create or update product channel listings."""
input: ProductChannelListingUpdateInput!
): ProductChannelListingUpdate
"""
Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productMediaCreate(
"""Fields required to create a product media."""
input: ProductMediaCreateInput!
): ProductMediaCreate
"""
Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantReorder(
"""The list of variant reordering operations."""
moves: [ReorderInput!]!
"""Id of product that variants order will be altered."""
productId: ID!
): ProductVariantReorder
"""
Deletes a product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productMediaDelete(
"""ID of a product media to delete."""
id: ID!
): ProductMediaDelete
"""
Deletes product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productMediaBulkDelete(
"""List of product media IDs to delete."""
ids: [ID!]!
): ProductMediaBulkDelete
"""
Changes ordering of the product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productMediaReorder(
"""IDs of a product media in the desired order."""
mediaIds: [ID!]!
"""ID of product that media order will be altered."""
productId: ID!
): ProductMediaReorder
"""
Updates a product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productMediaUpdate(
"""ID of a product media to update."""
id: ID!
"""Fields required to update a product media."""
input: ProductMediaUpdateInput!
): ProductMediaUpdate
"""
Creates a new product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productTypeCreate(
"""Fields required to create a product type."""
input: ProductTypeInput!
): ProductTypeCreate
"""
Deletes a product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productTypeDelete(
"""ID of a product type to delete."""
id: ID!
): ProductTypeDelete
"""
Deletes product types.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productTypeBulkDelete(
"""List of product type IDs to delete."""
ids: [ID!]!
): ProductTypeBulkDelete
"""
Updates an existing product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productTypeUpdate(
"""ID of a product type to update."""
id: ID!
"""Fields required to update a product type."""
input: ProductTypeInput!
): ProductTypeUpdate
"""
Reorder the attributes of a product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
productTypeReorderAttributes(
"""The list of attribute reordering operations."""
moves: [ReorderInput!]!
"""ID of a product type."""
productTypeId: ID!
"""The attribute type to reorder."""
type: ProductAttributeType!
): ProductTypeReorderAttributes
"""
Reorder product attribute values.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productReorderAttributeValues(
"""ID of an attribute."""
attributeId: ID!
"""The list of reordering operations for given attribute values."""
moves: [ReorderInput!]!
"""ID of a product."""
productId: ID!
): ProductReorderAttributeValues
"""
Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
digitalContentCreate(
"""Fields required to create a digital content."""
input: DigitalContentUploadInput!
"""ID of a product variant to upload digital content."""
variantId: ID!
): DigitalContentCreate
"""
Remove digital content assigned to given variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
digitalContentDelete(
"""ID of a product variant with digital content to remove."""
variantId: ID!
): DigitalContentDelete
"""
Update digital content.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
digitalContentUpdate(
"""Fields required to update a digital content."""
input: DigitalContentInput!
"""ID of a product variant with digital content to update."""
variantId: ID!
): DigitalContentUpdate
"""
Generate new URL to digital content.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
digitalContentUrlCreate(
"""Fields required to create a new url."""
input: DigitalContentUrlCreateInput!
): DigitalContentUrlCreate
"""
Creates a new variant for a product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantCreate(
"""Fields required to create a product variant."""
input: ProductVariantCreateInput!
): ProductVariantCreate
"""
Deletes a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantDelete(
"""ID of a product variant to delete."""
id: ID
"""
SKU of a product variant to delete.
Added in Saleor 3.8.
"""
sku: String
): ProductVariantDelete
"""
Creates product variants for a given product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantBulkCreate(
"""ID of the product to create the variants for."""
product: ID!
"""Input list of product variants to create."""
variants: [ProductVariantBulkCreateInput!]!
): ProductVariantBulkCreate
"""
Deletes product variants.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantBulkDelete(
"""List of product variant IDs to delete."""
ids: [ID!]
"""
List of product variant SKUs to delete.
Added in Saleor 3.8.
"""
skus: [String!]
): ProductVariantBulkDelete
"""
Creates stocks for product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantStocksCreate(
"""Input list of stocks to create."""
stocks: [StockInput!]!
"""ID of a product variant for which stocks will be created."""
variantId: ID!
): ProductVariantStocksCreate
"""
Delete stocks from product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantStocksDelete(
"""SKU of product variant for which stocks will be deleted."""
sku: String
"""ID of product variant for which stocks will be deleted."""
variantId: ID
"""Input list of warehouse IDs."""
warehouseIds: [ID!]
): ProductVariantStocksDelete
"""
Update stocks for product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantStocksUpdate(
"""SKU of product variant for which stocks will be updated."""
sku: String
"""Input list of stocks to create or update."""
stocks: [StockInput!]!
"""ID of a product variant for which stocks will be updated."""
variantId: ID
): ProductVariantStocksUpdate
"""
Updates an existing variant for product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantUpdate(
"""ID of a product variant to update."""
id: ID
"""Fields required to update a product variant."""
input: ProductVariantInput!
"""
SKU of a product variant to update.
Added in Saleor 3.8.
"""
sku: String
): ProductVariantUpdate
"""
Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantSetDefault(
"""Id of a product that will have the default variant set."""
productId: ID!
"""Id of a variant that will be set as default."""
variantId: ID!
): ProductVariantSetDefault
"""
Creates/updates translations for a product variant.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
productVariantTranslate(
"""ProductVariant ID or ProductVariantTranslatableContent ID."""
id: ID!
input: NameTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): ProductVariantTranslate
"""
Manage product variant prices in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantChannelListingUpdate(
"""ID of a product variant to update."""
id: ID
"""
List of fields required to create or upgrade product variant channel listings.
"""
input: [ProductVariantChannelListingAddInput!]!
"""
SKU of a product variant to update.
Added in Saleor 3.8.
"""
sku: String
): ProductVariantChannelListingUpdate
"""
Reorder product variant attribute values.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantReorderAttributeValues(
"""ID of an attribute."""
attributeId: ID!
"""The list of reordering operations for given attribute values."""
moves: [ReorderInput!]!
"""ID of a product variant."""
variantId: ID!
): ProductVariantReorderAttributeValues
"""
Deactivates product variant preorder. It changes all preorder allocation into regular allocation.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
productVariantPreorderDeactivate(
"""ID of a variant which preorder should be deactivated."""
id: ID!
): ProductVariantPreorderDeactivate
"""
Assign an media to a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
variantMediaAssign(
"""ID of a product media to assign to a variant."""
mediaId: ID!
"""ID of a product variant."""
variantId: ID!
): VariantMediaAssign
"""
Unassign an media from a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
variantMediaUnassign(
"""ID of a product media to unassign from a variant."""
mediaId: ID!
"""ID of a product variant."""
variantId: ID!
): VariantMediaUnassign
"""
Captures the authorized payment amount.
Requires one of the following permissions: MANAGE_ORDERS.
"""
paymentCapture(
"""Transaction amount."""
amount: PositiveDecimal
"""Payment ID."""
paymentId: ID!
): PaymentCapture
"""
Refunds the captured payment amount.
Requires one of the following permissions: MANAGE_ORDERS.
"""
paymentRefund(
"""Transaction amount."""
amount: PositiveDecimal
"""Payment ID."""
paymentId: ID!
): PaymentRefund
"""
Voids the authorized payment.
Requires one of the following permissions: MANAGE_ORDERS.
"""
paymentVoid(
"""Payment ID."""
paymentId: ID!
): PaymentVoid
"""Initializes payment process when it is required by gateway."""
paymentInitialize(
"""Slug of a channel for which the data should be returned."""
channel: String
"""A gateway name used to initialize the payment."""
gateway: String!
"""Client-side generated data required to initialize the payment."""
paymentData: JSONString
): PaymentInitialize
"""Check payment balance."""
paymentCheckBalance(
"""Fields required to check payment balance."""
input: PaymentCheckBalanceInput!
): PaymentCheckBalance
"""
Create transaction for checkout or order. Requires the following permissions: AUTHENTICATED_APP and HANDLE_PAYMENTS.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
transactionCreate(
"""The ID of the checkout or order."""
id: ID!
"""Input data required to create a new transaction object."""
transaction: TransactionCreateInput!
"""Data that defines a transaction event."""
transactionEvent: TransactionEventInput
): TransactionCreate
"""
Create transaction for checkout or order. Requires the following permissions: AUTHENTICATED_APP and HANDLE_PAYMENTS.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
transactionUpdate(
"""The ID of the transaction."""
id: ID!
"""Input data required to create a new transaction object."""
transaction: TransactionUpdateInput
"""Data that defines a transaction transaction."""
transactionEvent: TransactionEventInput
): TransactionUpdate
"""
Request an action for payment transaction.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
"""
transactionRequestAction(
"""Determines the action type."""
actionType: TransactionActionEnum!
"""
Transaction request amount. If empty for refund or capture, maximal possible amount will be used.
"""
amount: PositiveDecimal
"""The ID of the transaction."""
id: ID!
): TransactionRequestAction
"""
Creates a new page.
Requires one of the following permissions: MANAGE_PAGES.
"""
pageCreate(
"""Fields required to create a page."""
input: PageCreateInput!
): PageCreate
"""
Deletes a page.
Requires one of the following permissions: MANAGE_PAGES.
"""
pageDelete(
"""ID of a page to delete."""
id: ID!
): PageDelete
"""
Deletes pages.
Requires one of the following permissions: MANAGE_PAGES.
"""
pageBulkDelete(
"""List of page IDs to delete."""
ids: [ID!]!
): PageBulkDelete
"""
Publish pages.
Requires one of the following permissions: MANAGE_PAGES.
"""
pageBulkPublish(
"""List of page IDs to (un)publish."""
ids: [ID!]!
"""Determine if pages will be published or not."""
isPublished: Boolean!
): PageBulkPublish
"""
Updates an existing page.
Requires one of the following permissions: MANAGE_PAGES.
"""
pageUpdate(
"""ID of a page to update."""
id: ID!
"""Fields required to update a page."""
input: PageInput!
): PageUpdate
"""
Creates/updates translations for a page.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
pageTranslate(
"""Page ID or PageTranslatableContent ID."""
id: ID!
input: PageTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): PageTranslate
"""
Create a new page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
pageTypeCreate(
"""Fields required to create page type."""
input: PageTypeCreateInput!
): PageTypeCreate
"""
Update page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
pageTypeUpdate(
"""ID of the page type to update."""
id: ID
"""Fields required to update page type."""
input: PageTypeUpdateInput!
): PageTypeUpdate
"""
Delete a page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
pageTypeDelete(
"""ID of the page type to delete."""
id: ID!
): PageTypeDelete
"""
Delete page types.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
pageTypeBulkDelete(
"""List of page type IDs to delete"""
ids: [ID!]!
): PageTypeBulkDelete
"""
Assign attributes to a given page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
pageAttributeAssign(
"""The IDs of the attributes to assign."""
attributeIds: [ID!]!
"""ID of the page type to assign the attributes into."""
pageTypeId: ID!
): PageAttributeAssign
"""
Unassign attributes from a given page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
pageAttributeUnassign(
"""The IDs of the attributes to unassign."""
attributeIds: [ID!]!
"""ID of the page type from which the attributes should be unassign."""
pageTypeId: ID!
): PageAttributeUnassign
"""
Reorder the attributes of a page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
pageTypeReorderAttributes(
"""The list of attribute reordering operations."""
moves: [ReorderInput!]!
"""ID of a page type."""
pageTypeId: ID!
): PageTypeReorderAttributes
"""
Reorder page attribute values.
Requires one of the following permissions: MANAGE_PAGES.
"""
pageReorderAttributeValues(
"""ID of an attribute."""
attributeId: ID!
"""The list of reordering operations for given attribute values."""
moves: [ReorderInput!]!
"""ID of a page."""
pageId: ID!
): PageReorderAttributeValues
"""
Completes creating an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
draftOrderComplete(
"""ID of the order that will be completed."""
id: ID!
): DraftOrderComplete
"""
Creates a new draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
draftOrderCreate(
"""Fields required to create an order."""
input: DraftOrderCreateInput!
): DraftOrderCreate
"""
Deletes a draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
draftOrderDelete(
"""ID of a draft order to delete."""
id: ID!
): DraftOrderDelete
"""
Deletes draft orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
draftOrderBulkDelete(
"""List of draft order IDs to delete."""
ids: [ID!]!
): DraftOrderBulkDelete
"""
Deletes order lines.
Requires one of the following permissions: MANAGE_ORDERS.
"""
draftOrderLinesBulkDelete(
"""List of order lines IDs to delete."""
ids: [ID!]!
): DraftOrderLinesBulkDelete @deprecated(reason: "This field will be removed in Saleor 4.0.")
"""
Updates a draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
draftOrderUpdate(
"""ID of a draft order to update."""
id: ID!
"""Fields required to update an order."""
input: DraftOrderInput!
): DraftOrderUpdate
"""
Adds note to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderAddNote(
"""ID of the order to add a note for."""
order: ID!
"""Fields required to create a note for the order."""
input: OrderAddNoteInput!
): OrderAddNote
"""
Cancel an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderCancel(
"""ID of the order to cancel."""
id: ID!
): OrderCancel
"""
Capture an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderCapture(
"""Amount of money to capture."""
amount: PositiveDecimal!
"""ID of the order to capture."""
id: ID!
): OrderCapture
"""
Confirms an unconfirmed order by changing status to unfulfilled.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderConfirm(
"""ID of an order to confirm."""
id: ID!
): OrderConfirm
"""
Creates new fulfillments for an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderFulfill(
"""Fields required to create a fulfillment."""
input: OrderFulfillInput!
"""ID of the order to be fulfilled."""
order: ID
): OrderFulfill
"""
Cancels existing fulfillment and optionally restocks items.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderFulfillmentCancel(
"""ID of a fulfillment to cancel."""
id: ID!
"""Fields required to cancel a fulfillment."""
input: FulfillmentCancelInput
): FulfillmentCancel
"""
Approve existing fulfillment.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderFulfillmentApprove(
"""True if stock could be exceeded."""
allowStockToBeExceeded: Boolean = false
"""ID of a fulfillment to approve."""
id: ID!
"""True if confirmation email should be send."""
notifyCustomer: Boolean!
): FulfillmentApprove
"""
Updates a fulfillment for an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderFulfillmentUpdateTracking(
"""ID of a fulfillment to update."""
id: ID!
"""Fields required to update a fulfillment."""
input: FulfillmentUpdateTrackingInput!
): FulfillmentUpdateTracking
"""
Refund products.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderFulfillmentRefundProducts(
"""Fields required to create an refund fulfillment."""
input: OrderRefundProductsInput!
"""ID of the order to be refunded."""
order: ID!
): FulfillmentRefundProducts
"""
Return products.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderFulfillmentReturnProducts(
"""Fields required to return products."""
input: OrderReturnProductsInput!
"""ID of the order to be returned."""
order: ID!
): FulfillmentReturnProducts
"""
Create order lines for an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderLinesCreate(
"""ID of the order to add the lines to."""
id: ID!
"""Fields required to add order lines."""
input: [OrderLineCreateInput!]!
): OrderLinesCreate
"""
Deletes an order line from an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderLineDelete(
"""ID of the order line to delete."""
id: ID!
): OrderLineDelete
"""
Updates an order line of an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderLineUpdate(
"""ID of the order line to update."""
id: ID!
"""Fields required to update an order line."""
input: OrderLineInput!
): OrderLineUpdate
"""
Adds discount to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderDiscountAdd(
"""Fields required to create a discount for the order."""
input: OrderDiscountCommonInput!
"""ID of an order to discount."""
orderId: ID!
): OrderDiscountAdd
"""
Update discount for the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderDiscountUpdate(
"""ID of a discount to update."""
discountId: ID!
"""Fields required to update a discount for the order."""
input: OrderDiscountCommonInput!
): OrderDiscountUpdate
"""
Remove discount from the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderDiscountDelete(
"""ID of a discount to remove."""
discountId: ID!
): OrderDiscountDelete
"""
Update discount for the order line.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderLineDiscountUpdate(
"""Fields required to update price for the order line."""
input: OrderDiscountCommonInput!
"""ID of a order line to update price"""
orderLineId: ID!
): OrderLineDiscountUpdate
"""
Remove discount applied to the order line.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderLineDiscountRemove(
"""ID of a order line to remove its discount"""
orderLineId: ID!
): OrderLineDiscountRemove
"""
Mark order as manually paid.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderMarkAsPaid(
"""ID of the order to mark paid."""
id: ID!
"""The external transaction reference."""
transactionReference: String
): OrderMarkAsPaid
"""
Refund an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderRefund(
"""Amount of money to refund."""
amount: PositiveDecimal!
"""ID of the order to refund."""
id: ID!
): OrderRefund
"""
Updates an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderUpdate(
"""ID of an order to update."""
id: ID!
"""Fields required to update an order."""
input: OrderUpdateInput!
): OrderUpdate
"""
Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderUpdateShipping(
"""ID of the order to update a shipping method."""
order: ID!
"""Fields required to change shipping method of the order."""
input: OrderUpdateShippingInput!
): OrderUpdateShipping
"""
Void an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderVoid(
"""ID of the order to void."""
id: ID!
): OrderVoid
"""
Cancels orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderBulkCancel(
"""List of orders IDs to cancel."""
ids: [ID!]!
): OrderBulkCancel
"""
Delete metadata of an object. To use it, you need to have access to the modified object.
"""
deleteMetadata(
"""ID or token (for Order and Checkout) of an object to update."""
id: ID!
"""Metadata keys to delete."""
keys: [String!]!
): DeleteMetadata
"""
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.
"""
deletePrivateMetadata(
"""ID or token (for Order and Checkout) of an object to update."""
id: ID!
"""Metadata keys to delete."""
keys: [String!]!
): DeletePrivateMetadata
"""
Updates metadata of an object. To use it, you need to have access to the modified object.
"""
updateMetadata(
"""ID or token (for Order and Checkout) of an object to update."""
id: ID!
"""Fields required to update the object's metadata."""
input: [MetadataInput!]!
): UpdateMetadata
"""
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.
"""
updatePrivateMetadata(
"""ID or token (for Order and Checkout) of an object to update."""
id: ID!
"""Fields required to update the object's metadata."""
input: [MetadataInput!]!
): UpdatePrivateMetadata
"""
Assigns storefront's navigation menus.
Requires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS.
"""
assignNavigation(
"""ID of the menu."""
menu: ID
"""Type of the navigation bar to assign the menu to."""
navigationType: NavigationType!
): AssignNavigation
"""
Creates a new Menu.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuCreate(
"""Fields required to create a menu."""
input: MenuCreateInput!
): MenuCreate
"""
Deletes a menu.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuDelete(
"""ID of a menu to delete."""
id: ID!
): MenuDelete
"""
Deletes menus.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuBulkDelete(
"""List of menu IDs to delete."""
ids: [ID!]!
): MenuBulkDelete
"""
Updates a menu.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuUpdate(
"""ID of a menu to update."""
id: ID!
"""Fields required to update a menu."""
input: MenuInput!
): MenuUpdate
"""
Creates a new menu item.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuItemCreate(
"""
Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
"""
input: MenuItemCreateInput!
): MenuItemCreate
"""
Deletes a menu item.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuItemDelete(
"""ID of a menu item to delete."""
id: ID!
): MenuItemDelete
"""
Deletes menu items.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuItemBulkDelete(
"""List of menu item IDs to delete."""
ids: [ID!]!
): MenuItemBulkDelete
"""
Updates a menu item.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuItemUpdate(
"""ID of a menu item to update."""
id: ID!
"""
Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
"""
input: MenuItemInput!
): MenuItemUpdate
"""
Creates/updates translations for a menu item.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
menuItemTranslate(
"""MenuItem ID or MenuItemTranslatableContent ID."""
id: ID!
input: NameTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): MenuItemTranslate
"""
Moves items of menus.
Requires one of the following permissions: MANAGE_MENUS.
"""
menuItemMove(
"""ID of the menu."""
menu: ID!
"""The menu position data."""
moves: [MenuItemMoveInput!]!
): MenuItemMove
"""
Request an invoice for the order using plugin.
Requires one of the following permissions: MANAGE_ORDERS.
"""
invoiceRequest(
"""Invoice number, if not provided it will be generated."""
number: String
"""ID of the order related to invoice."""
orderId: ID!
): InvoiceRequest
"""
Requests deletion of an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
invoiceRequestDelete(
"""ID of an invoice to request the deletion."""
id: ID!
): InvoiceRequestDelete
"""
Creates a ready to send invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
invoiceCreate(
"""Fields required when creating an invoice."""
input: InvoiceCreateInput!
"""ID of the order related to invoice."""
orderId: ID!
): InvoiceCreate
"""
Deletes an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
invoiceDelete(
"""ID of an invoice to delete."""
id: ID!
): InvoiceDelete
"""
Updates an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
invoiceUpdate(
"""ID of an invoice to update."""
id: ID!
"""Fields to use when updating an invoice."""
input: UpdateInvoiceInput!
): InvoiceUpdate
"""
Send an invoice notification to the customer.
Requires one of the following permissions: MANAGE_ORDERS.
"""
invoiceSendNotification(
"""ID of an invoice to be sent."""
id: ID!
): InvoiceSendNotification
"""
Activate a gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardActivate(
"""ID of a gift card to activate."""
id: ID!
): GiftCardActivate
"""
Creates a new gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardCreate(
"""Fields required to create a gift card."""
input: GiftCardCreateInput!
): GiftCardCreate
"""
Delete gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardDelete(
"""ID of the gift card to delete."""
id: ID!
): GiftCardDelete
"""
Deactivate a gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardDeactivate(
"""ID of a gift card to deactivate."""
id: ID!
): GiftCardDeactivate
"""
Update a gift card.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardUpdate(
"""ID of a gift card to update."""
id: ID!
"""Fields required to update a gift card."""
input: GiftCardUpdateInput!
): GiftCardUpdate
"""
Resend a gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardResend(
"""Fields required to resend a gift card."""
input: GiftCardResendInput!
): GiftCardResend
"""
Adds note to the gift card.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardAddNote(
"""ID of the gift card to add a note for."""
id: ID!
"""Fields required to create a note for the gift card."""
input: GiftCardAddNoteInput!
): GiftCardAddNote
"""
Create gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardBulkCreate(
"""Fields required to create gift cards."""
input: GiftCardBulkCreateInput!
): GiftCardBulkCreate
"""
Delete gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardBulkDelete(
"""List of gift card IDs to delete."""
ids: [ID!]!
): GiftCardBulkDelete
"""
Activate gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardBulkActivate(
"""List of gift card IDs to activate."""
ids: [ID!]!
): GiftCardBulkActivate
"""
Deactivate gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardBulkDeactivate(
"""List of gift card IDs to deactivate."""
ids: [ID!]!
): GiftCardBulkDeactivate
"""
Update plugin configuration.
Requires one of the following permissions: MANAGE_PLUGINS.
"""
pluginUpdate(
"""ID of a channel for which the data should be modified."""
channelId: ID
"""ID of plugin to update."""
id: ID!
"""Fields required to update a plugin configuration."""
input: PluginUpdateInput!
): PluginUpdate
"""
Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload.
Added in Saleor 3.1.
"""
externalNotificationTrigger(
"""
Channel slug. Saleor will send a notification within a provided channel. Please, make sure that necessary plugins are active.
"""
channel: String!
"""Input for External Notification Trigger."""
input: ExternalNotificationTriggerInput!
"""The ID of notification plugin."""
pluginId: String
): ExternalNotificationTrigger
"""
Creates a new sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
saleCreate(
"""Fields required to create a sale."""
input: SaleInput!
): SaleCreate
"""
Deletes a sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
saleDelete(
"""ID of a sale to delete."""
id: ID!
): SaleDelete
"""
Deletes sales.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
saleBulkDelete(
"""List of sale IDs to delete."""
ids: [ID!]!
): SaleBulkDelete
"""
Updates a sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
saleUpdate(
"""ID of a sale to update."""
id: ID!
"""Fields required to update a sale."""
input: SaleInput!
): SaleUpdate
"""
Adds products, categories, collections to a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
saleCataloguesAdd(
"""ID of a sale."""
id: ID!
"""Fields required to modify catalogue IDs of sale."""
input: CatalogueInput!
): SaleAddCatalogues
"""
Removes products, categories, collections from a sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
saleCataloguesRemove(
"""ID of a sale."""
id: ID!
"""Fields required to modify catalogue IDs of sale."""
input: CatalogueInput!
): SaleRemoveCatalogues
"""
Creates/updates translations for a sale.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
saleTranslate(
"""Sale ID or SaleTranslatableContent ID."""
id: ID!
input: NameTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): SaleTranslate
"""
Manage sale's availability in channels.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
saleChannelListingUpdate(
"""ID of a sale to update."""
id: ID!
"""Fields required to update sale channel listings."""
input: SaleChannelListingInput!
): SaleChannelListingUpdate
"""
Creates a new voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucherCreate(
"""Fields required to create a voucher."""
input: VoucherInput!
): VoucherCreate
"""
Deletes a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucherDelete(
"""ID of a voucher to delete."""
id: ID!
): VoucherDelete
"""
Deletes vouchers.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucherBulkDelete(
"""List of voucher IDs to delete."""
ids: [ID!]!
): VoucherBulkDelete
"""
Updates a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucherUpdate(
"""ID of a voucher to update."""
id: ID!
"""Fields required to update a voucher."""
input: VoucherInput!
): VoucherUpdate
"""
Adds products, categories, collections to a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucherCataloguesAdd(
"""ID of a voucher."""
id: ID!
"""Fields required to modify catalogue IDs of voucher."""
input: CatalogueInput!
): VoucherAddCatalogues
"""
Removes products, categories, collections from a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucherCataloguesRemove(
"""ID of a voucher."""
id: ID!
"""Fields required to modify catalogue IDs of voucher."""
input: CatalogueInput!
): VoucherRemoveCatalogues
"""
Creates/updates translations for a voucher.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
voucherTranslate(
"""Voucher ID or VoucherTranslatableContent ID."""
id: ID!
input: NameTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): VoucherTranslate
"""
Manage voucher's availability in channels.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucherChannelListingUpdate(
"""ID of a voucher to update."""
id: ID!
"""Fields required to update voucher channel listings."""
input: VoucherChannelListingInput!
): VoucherChannelListingUpdate
"""
Export products to csv file.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
exportProducts(
"""Fields required to export product data."""
input: ExportProductsInput!
): ExportProducts
"""
Export gift cards to csv file.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
exportGiftCards(
"""Fields required to export gift cards data."""
input: ExportGiftCardsInput!
): ExportGiftCards
"""
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
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
fileUpload(
"""Represents a file in a multipart request."""
file: Upload!
): FileUpload
"""Adds a gift card or a voucher to a checkout."""
checkoutAddPromoCode(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""Gift card code or voucher code."""
promoCode: String!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutAddPromoCode
"""Update billing address in the existing checkout."""
checkoutBillingAddressUpdate(
"""The billing address of the checkout."""
billingAddress: AddressInput!
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
"""
The rules for changing validation for received billing address data.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
validationRules: CheckoutAddressValidationRules
): CheckoutBillingAddressUpdate
"""
Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.
"""
checkoutComplete(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
Fields required to update the checkout metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""Client-side generated data required to finalize the payment."""
paymentData: JSONString
"""
URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.
"""
redirectUrl: String
"""
Determines whether to store the payment source for future usage.
DEPRECATED: this field will be removed in Saleor 4.0. Use checkoutPaymentCreate for this action.
"""
storeSource: Boolean = false
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutComplete
"""Create a new checkout."""
checkoutCreate(
"""Fields required to create checkout."""
input: CheckoutCreateInput!
): CheckoutCreate
"""
Sets the customer as the owner of the checkout.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.
"""
checkoutCustomerAttach(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
ID of customer to attach to checkout. Requires IMPERSONATE_USER permission when customerId is different than the logged-in user.
"""
customerId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutCustomerAttach
"""
Removes the user assigned as the owner of the checkout.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER.
"""
checkoutCustomerDetach(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutCustomerDetach
"""Updates email address in the existing checkout object."""
checkoutEmailUpdate(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""email."""
email: String!
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutEmailUpdate
"""Deletes a CheckoutLine."""
checkoutLineDelete(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""ID of the checkout line to delete."""
lineId: ID
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutLineDelete @deprecated(reason: "This field will be removed in Saleor 4.0. Use `checkoutLinesDelete` instead.")
"""Deletes checkout lines."""
checkoutLinesDelete(
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""A list of checkout lines."""
linesIds: [ID!]!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutLinesDelete
"""
Adds a checkout line to the existing checkout.If line was already in checkout, its quantity will be increased.
"""
checkoutLinesAdd(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLineInput!]!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutLinesAdd
"""Updates checkout line in the existing checkout."""
checkoutLinesUpdate(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
A list of checkout lines, each containing information about an item in the checkout.
"""
lines: [CheckoutLineUpdateInput!]!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutLinesUpdate
"""Remove a gift card or a voucher from a checkout."""
checkoutRemovePromoCode(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""Gift card code or voucher code."""
promoCode: String
"""Gift card or voucher ID."""
promoCodeId: ID
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutRemovePromoCode
"""Create a new payment for given checkout."""
checkoutPaymentCreate(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""Data required to create a new payment."""
input: PaymentInput!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutPaymentCreate
"""Update shipping address in the existing checkout."""
checkoutShippingAddressUpdate(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""The mailing address to where the checkout will be shipped."""
shippingAddress: AddressInput!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
"""
The rules for changing validation for received shipping address data.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
validationRules: CheckoutAddressValidationRules
): CheckoutShippingAddressUpdate
"""Updates the shipping method of the checkout."""
checkoutShippingMethodUpdate(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""Shipping method."""
shippingMethodId: ID!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutShippingMethodUpdate @deprecated(reason: "This field will be removed in Saleor 4.0. Use `checkoutDeliveryMethodUpdate` instead.")
"""
Updates the delivery method (shipping method or pick up point) of the checkout.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
checkoutDeliveryMethodUpdate(
"""Delivery Method ID (`Warehouse` ID or `ShippingMethod` ID)."""
deliveryMethodId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutDeliveryMethodUpdate
"""Update language code in the existing checkout."""
checkoutLanguageCodeUpdate(
"""
The ID of the checkout.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
checkoutId: ID
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""New language code."""
languageCode: LanguageCodeEnum!
"""
Checkout token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): CheckoutLanguageCodeUpdate
"""
Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
orderCreateFromCheckout(
"""ID of a checkout that will be converted to an order."""
id: ID!
"""
Fields required to update the checkout metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the checkout private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
"""
Determines if checkout should be removed after creating an order. Default true.
"""
removeCheckout: Boolean = true
): OrderCreateFromCheckout
"""
Creates new channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
channelCreate(
"""Fields required to create channel."""
input: ChannelCreateInput!
): ChannelCreate
"""
Update a channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
channelUpdate(
"""ID of a channel to update."""
id: ID!
"""Fields required to update a channel."""
input: ChannelUpdateInput!
): ChannelUpdate
"""
Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
channelDelete(
"""ID of a channel to delete."""
id: ID!
"""Fields required to delete a channel."""
input: ChannelDeleteInput
): ChannelDelete
"""
Activate a channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
channelActivate(
"""ID of the channel to activate."""
id: ID!
): ChannelActivate
"""
Deactivate a channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
channelDeactivate(
"""ID of the channel to deactivate."""
id: ID!
): ChannelDeactivate
"""
Reorder the warehouses of a channel.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
channelReorderWarehouses(
"""ID of a channel."""
channelId: ID!
"""The list of reordering operations for the given channel warehouses."""
moves: [ReorderInput!]!
): ChannelReorderWarehouses
"""Creates an attribute."""
attributeCreate(
"""Fields required to create an attribute."""
input: AttributeCreateInput!
): AttributeCreate
"""
Deletes an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
attributeDelete(
"""ID of an attribute to delete."""
id: ID!
): AttributeDelete
"""
Updates attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
attributeUpdate(
"""ID of an attribute to update."""
id: ID!
"""Fields required to update an attribute."""
input: AttributeUpdateInput!
): AttributeUpdate
"""
Creates/updates translations for an attribute.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
attributeTranslate(
"""Attribute ID or AttributeTranslatableContent ID."""
id: ID!
input: NameTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): AttributeTranslate
"""
Deletes attributes.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
attributeBulkDelete(
"""List of attribute IDs to delete."""
ids: [ID!]!
): AttributeBulkDelete
"""
Deletes values of attributes.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
attributeValueBulkDelete(
"""List of attribute value IDs to delete."""
ids: [ID!]!
): AttributeValueBulkDelete
"""
Creates a value for an attribute.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
attributeValueCreate(
"""Attribute to which value will be assigned."""
attribute: ID!
"""Fields required to create an AttributeValue."""
input: AttributeValueCreateInput!
): AttributeValueCreate
"""
Deletes a value of an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
attributeValueDelete(
"""ID of a value to delete."""
id: ID!
): AttributeValueDelete
"""
Updates value of an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
attributeValueUpdate(
"""ID of an AttributeValue to update."""
id: ID!
"""Fields required to update an AttributeValue."""
input: AttributeValueUpdateInput!
): AttributeValueUpdate
"""
Creates/updates translations for an attribute value.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
attributeValueTranslate(
"""AttributeValue ID or AttributeValueTranslatableContent ID."""
id: ID!
input: AttributeValueTranslationInput!
"""Translation language code."""
languageCode: LanguageCodeEnum!
): AttributeValueTranslate
"""
Reorder the values of an attribute.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
attributeReorderValues(
"""ID of an attribute."""
attributeId: ID!
"""The list of reordering operations for given attribute values."""
moves: [ReorderInput!]!
): AttributeReorderValues
"""
Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
"""
appCreate(
"""Fields required to create a new app."""
input: AppInput!
): AppCreate
"""
Updates an existing app.
Requires one of the following permissions: MANAGE_APPS.
"""
appUpdate(
"""ID of an app to update."""
id: ID!
"""Fields required to update an existing app."""
input: AppInput!
): AppUpdate
"""
Deletes an app.
Requires one of the following permissions: MANAGE_APPS.
"""
appDelete(
"""ID of an app to delete."""
id: ID!
): AppDelete
"""
Creates a new token.
Requires one of the following permissions: MANAGE_APPS.
"""
appTokenCreate(
"""Fields required to create a new auth token."""
input: AppTokenInput!
): AppTokenCreate
"""
Deletes an authentication token assigned to app.
Requires one of the following permissions: MANAGE_APPS.
"""
appTokenDelete(
"""ID of an auth token to delete."""
id: ID!
): AppTokenDelete
"""Verify provided app token."""
appTokenVerify(
"""App token to verify."""
token: String!
): AppTokenVerify
"""
Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
"""
appInstall(
"""Fields required to install a new app."""
input: AppInstallInput!
): AppInstall
"""
Retry failed installation of new app.
Requires one of the following permissions: MANAGE_APPS.
"""
appRetryInstall(
"""Determine if app will be set active or not."""
activateAfterInstallation: Boolean = true
"""ID of failed installation."""
id: ID!
): AppRetryInstall
"""
Delete failed installation.
Requires one of the following permissions: MANAGE_APPS.
"""
appDeleteFailedInstallation(
"""ID of failed installation to delete."""
id: ID!
): AppDeleteFailedInstallation
"""
Fetch and validate manifest.
Requires one of the following permissions: MANAGE_APPS.
"""
appFetchManifest(manifestUrl: String!): AppFetchManifest
"""
Activate the app.
Requires one of the following permissions: MANAGE_APPS.
"""
appActivate(
"""ID of app to activate."""
id: ID!
): AppActivate
"""
Deactivate the app.
Requires one of the following permissions: MANAGE_APPS.
"""
appDeactivate(
"""ID of app to deactivate."""
id: ID!
): AppDeactivate
"""Create JWT token."""
tokenCreate(
"""
The audience that will be included to JWT tokens with prefix `custom:`.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
audience: String
"""Email of a user."""
email: String!
"""Password of a user."""
password: String!
): CreateToken
"""
Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie.
"""
tokenRefresh(
"""
CSRF token required to refresh token. This argument is required when refreshToken is provided as a cookie.
"""
csrfToken: String
"""Refresh token."""
refreshToken: String
): RefreshToken
"""Verify JWT token."""
tokenVerify(
"""JWT token to validate."""
token: String!
): VerifyToken
"""
Deactivate all JWT tokens of the currently authenticated user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
tokensDeactivateAll: DeactivateAllUserTokens
"""Prepare external authentication url for user by custom plugin."""
externalAuthenticationUrl(
"""The data required by plugin to create external authentication url."""
input: JSONString!
"""The ID of the authentication plugin."""
pluginId: String!
): ExternalAuthenticationUrl
"""Obtain external access tokens for user by custom plugin."""
externalObtainAccessTokens(
"""The data required by plugin to create authentication data."""
input: JSONString!
"""The ID of the authentication plugin."""
pluginId: String!
): ExternalObtainAccessTokens
"""Refresh user's access by custom plugin."""
externalRefresh(
"""The data required by plugin to proceed the refresh process."""
input: JSONString!
"""The ID of the authentication plugin."""
pluginId: String!
): ExternalRefresh
"""Logout user by custom plugin."""
externalLogout(
"""The data required by plugin to proceed the logout process."""
input: JSONString!
"""The ID of the authentication plugin."""
pluginId: String!
): ExternalLogout
"""Verify external authentication data by plugin."""
externalVerify(
"""The data required by plugin to proceed the verification."""
input: JSONString!
"""The ID of the authentication plugin."""
pluginId: String!
): ExternalVerify
"""Sends an email with the account password modification link."""
requestPasswordReset(
"""
Slug of a channel which will be used for notify user. Optional when only one channel exists.
"""
channel: String
"""Email of the user that will be used for password recovery."""
email: String!
"""
URL of a view where users should be redirected to reset the password. URL in RFC 1808 format.
"""
redirectUrl: String!
): RequestPasswordReset
"""Confirm user account with token sent by email during registration."""
confirmAccount(
"""E-mail of the user performing account confirmation."""
email: String!
"""A one-time token required to confirm the account."""
token: String!
): ConfirmAccount
"""
Sets the user's password from the token sent by email using the RequestPasswordReset mutation.
"""
setPassword(
"""Email of a user."""
email: String!
"""Password of a user."""
password: String!
"""A one-time token required to set the password."""
token: String!
): SetPassword
"""
Change the password of the logged in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
passwordChange(
"""New user password."""
newPassword: String!
"""Current user password."""
oldPassword: String!
): PasswordChange
"""
Request email change of the logged in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
requestEmailChange(
"""
Slug of a channel which will be used to notify users. Optional when only one channel exists.
"""
channel: String
"""New user email."""
newEmail: String!
"""User password."""
password: String!
"""
URL of a view where users should be redirected to update the email address. URL in RFC 1808 format.
"""
redirectUrl: String!
): RequestEmailChange
"""
Confirm the email change of the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
confirmEmailChange(
"""
Slug of a channel which will be used to notify users. Optional when only one channel exists.
"""
channel: String
"""A one-time token required to change the email."""
token: String!
): ConfirmEmailChange
"""
Create a new address for the customer.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
accountAddressCreate(
"""Fields required to create address."""
input: AddressInput!
"""
A type of address. If provided, the new address will be automatically assigned as the customer's default address of that type.
"""
type: AddressTypeEnum
): AccountAddressCreate
"""
Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
"""
accountAddressUpdate(
"""ID of the address to update."""
id: ID!
"""Fields required to update the address."""
input: AddressInput!
): AccountAddressUpdate
"""
Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
"""
accountAddressDelete(
"""ID of the address to delete."""
id: ID!
): AccountAddressDelete
"""
Sets a default address for the authenticated user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
accountSetDefaultAddress(
"""ID of the address to set as default."""
id: ID!
"""The type of address."""
type: AddressTypeEnum!
): AccountSetDefaultAddress
"""Register a new user."""
accountRegister(
"""Fields required to create a user."""
input: AccountRegisterInput!
): AccountRegister
"""
Updates the account of the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
accountUpdate(
"""Fields required to update the account of the logged-in user."""
input: AccountInput!
): AccountUpdate
"""
Sends an email with the account removal link for the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
accountRequestDeletion(
"""
Slug of a channel which will be used to notify users. Optional when only one channel exists.
"""
channel: String
"""
URL of a view where users should be redirected to delete their account. URL in RFC 1808 format.
"""
redirectUrl: String!
): AccountRequestDeletion
"""
Remove user account.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
accountDelete(
"""
A one-time token required to remove account. Sent by email using AccountRequestDeletion mutation.
"""
token: String!
): AccountDelete
"""
Creates user address.
Requires one of the following permissions: MANAGE_USERS.
"""
addressCreate(
"""Fields required to create address."""
input: AddressInput!
"""ID of a user to create address for."""
userId: ID!
): AddressCreate
"""
Updates an address.
Requires one of the following permissions: MANAGE_USERS.
"""
addressUpdate(
"""ID of the address to update."""
id: ID!
"""Fields required to update the address."""
input: AddressInput!
): AddressUpdate
"""
Deletes an address.
Requires one of the following permissions: MANAGE_USERS.
"""
addressDelete(
"""ID of the address to delete."""
id: ID!
): AddressDelete
"""
Sets a default address for the given user.
Requires one of the following permissions: MANAGE_USERS.
"""
addressSetDefault(
"""ID of the address."""
addressId: ID!
"""The type of address."""
type: AddressTypeEnum!
"""ID of the user to change the address for."""
userId: ID!
): AddressSetDefault
"""
Creates a new customer.
Requires one of the following permissions: MANAGE_USERS.
"""
customerCreate(
"""Fields required to create a customer."""
input: UserCreateInput!
): CustomerCreate
"""
Updates an existing customer.
Requires one of the following permissions: MANAGE_USERS.
"""
customerUpdate(
"""ID of a customer to update."""
id: ID!
"""Fields required to update a customer."""
input: CustomerInput!
): CustomerUpdate
"""
Deletes a customer.
Requires one of the following permissions: MANAGE_USERS.
"""
customerDelete(
"""ID of a customer to delete."""
id: ID!
): CustomerDelete
"""
Deletes customers.
Requires one of the following permissions: MANAGE_USERS.
"""
customerBulkDelete(
"""List of user IDs to delete."""
ids: [ID!]!
): CustomerBulkDelete
"""
Creates a new staff user. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
staffCreate(
"""Fields required to create a staff user."""
input: StaffCreateInput!
): StaffCreate
"""
Updates an existing staff user. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
staffUpdate(
"""ID of a staff user to update."""
id: ID!
"""Fields required to update a staff user."""
input: StaffUpdateInput!
): StaffUpdate
"""
Deletes a staff user. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
staffDelete(
"""ID of a staff user to delete."""
id: ID!
): StaffDelete
"""
Deletes staff users. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
staffBulkDelete(
"""List of user IDs to delete."""
ids: [ID!]!
): StaffBulkDelete
"""
Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
userAvatarUpdate(
"""Represents an image file in a multipart request."""
image: Upload!
): UserAvatarUpdate
"""
Deletes a user avatar. Only for staff members.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
userAvatarDelete: UserAvatarDelete
"""
Activate or deactivate users.
Requires one of the following permissions: MANAGE_USERS.
"""
userBulkSetActive(
"""List of user IDs to (de)activate)."""
ids: [ID!]!
"""Determine if users will be set active or not."""
isActive: Boolean!
): UserBulkSetActive
"""
Create new permission group. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
permissionGroupCreate(
"""Input fields to create permission group."""
input: PermissionGroupCreateInput!
): PermissionGroupCreate
"""
Update permission group. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
permissionGroupUpdate(
"""ID of the group to update."""
id: ID!
"""Input fields to create permission group."""
input: PermissionGroupUpdateInput!
): PermissionGroupUpdate
"""
Delete permission group. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
permissionGroupDelete(
"""ID of the group to delete."""
id: ID!
): PermissionGroupDelete
}
input NameTranslationInput {
name: String
}
enum NavigationType {
"""Main storefront navigation."""
MAIN
"""Secondary storefront navigation."""
SECONDARY
}
"""An object with an ID"""
interface Node {
"""The ID of the object."""
id: ID!
}
interface ObjectWithMetadata {
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
}
"""Represents an order in the shop."""
type Order implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
created: DateTime!
updatedAt: DateTime!
status: OrderStatus!
"""
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.
"""
user: User
trackingClientId: String!
"""
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.
"""
billingAddress: Address
"""
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.
"""
shippingAddress: Address
shippingMethodName: String
collectionPointName: String
channel: Channel!
"""List of shipments for the order."""
fulfillments: [Fulfillment!]!
"""List of order lines."""
lines: [OrderLine!]!
"""
List of actions that can be performed in the current state of an order.
"""
actions: [OrderAction!]!
"""Shipping methods that can be used with this order."""
availableShippingMethods: [ShippingMethod!] @deprecated(reason: "Use `shippingMethods`, this field will be removed in 4.0")
"""Shipping methods related to this order."""
shippingMethods: [ShippingMethod!]!
"""
Collection points that can be used for this order.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
availableCollectionPoints: [Warehouse!]!
"""
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.
"""
invoices: [Invoice!]!
"""User-friendly number of an order."""
number: String!
"""The ID of the order that was the base for this order."""
original: ID
"""The order origin."""
origin: OrderOriginEnum!
"""Informs if an order is fully paid."""
isPaid: Boolean!
"""Internal payment status."""
paymentStatus: PaymentChargeStatusEnum!
"""User-friendly payment status."""
paymentStatusDisplay: String!
"""
The authorize status of the order.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
authorizeStatus: OrderAuthorizeStatusEnum!
"""
The charge status of the order.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
chargeStatus: OrderChargeStatusEnum!
"""
Returns True if order has to be exempt from taxes.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
taxExemption: Boolean!
"""
List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
transactions: [TransactionItem!]!
"""List of payments for the order."""
payments: [Payment!]!
"""Total amount of the order."""
total: TaxedMoney!
"""Undiscounted total amount of the order."""
undiscountedTotal: TaxedMoney!
"""Shipping method for this order."""
shippingMethod: ShippingMethod @deprecated(reason: "This field will be removed in Saleor 4.0. Use `deliveryMethod` instead.")
"""Total price of shipping."""
shippingPrice: TaxedMoney!
"""The shipping tax rate value."""
shippingTaxRate: Float!
"""
Denormalized tax class assigned to the shipping method.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
shippingTaxClass: TaxClass
"""
Denormalized name of the tax class assigned to the shipping method.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
shippingTaxClassName: String
"""
Denormalized public metadata of the shipping method's tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
shippingTaxClassMetadata: [MetadataItem!]!
"""
Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
shippingTaxClassPrivateMetadata: [MetadataItem!]!
token: String! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `id` instead.")
voucher: Voucher
"""List of user gift cards."""
giftCards: [GiftCard!]!
customerNote: String!
weight: Weight!
redirectUrl: String
"""The sum of line prices not including shipping."""
subtotal: TaxedMoney!
"""User-friendly order status."""
statusDisplay: String!
"""
Informs whether a draft order can be finalized(turned into a regular order).
"""
canFinalize: Boolean!
"""Amount authorized for the order."""
totalAuthorized: Money!
"""Amount captured by payment."""
totalCaptured: Money!
"""
List of events associated with the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
events: [OrderEvent!]!
"""The difference between the paid and the order total amount."""
totalBalance: Money!
"""
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.
"""
userEmail: String
"""Returns True, if order requires shipping."""
isShippingRequired: Boolean!
"""
The delivery method selected for this order.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
deliveryMethod: DeliveryMethod
languageCode: String! @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `languageCodeEnum` field to fetch the language code. ")
"""Order language code."""
languageCodeEnum: LanguageCodeEnum!
"""Returns applied discount."""
discount: Money @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `discounts` field instead.")
"""Discount name."""
discountName: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `discounts` field instead.")
"""Translated discount name."""
translatedDiscountName: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `discounts` field instead. ")
"""List of all discounts assigned to the order."""
discounts: [OrderDiscount!]!
"""List of errors that occurred during order validation."""
errors: [OrderError!]!
"""
Determines whether checkout prices should include taxes when displayed in a storefront.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
displayGrossPrices: Boolean!
}
enum OrderAction {
"""Represents the capture action."""
CAPTURE
"""Represents a mark-as-paid action."""
MARK_AS_PAID
"""Represents a refund action."""
REFUND
"""Represents a void action."""
VOID
}
"""
Adds note to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderAddNote {
"""Order with the note added."""
order: Order
"""Order note created."""
event: OrderEvent
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input OrderAddNoteInput {
"""Note message."""
message: String!
}
"""
Determine a current authorize status for order.
We treat the order as fully authorized when the sum of authorized and charged funds
cover the order.total.
We treat the order as partially authorized when the sum of authorized and charged
funds covers only part of the order.total
We treat the order as not authorized when the sum of authorized and charged funds is
0.
NONE - the funds are not authorized
PARTIAL - the funds that are authorized or charged don't cover fully the order's
total
FULL - the funds that are authorized or charged fully cover the order's total
"""
enum OrderAuthorizeStatusEnum {
NONE
PARTIAL
FULL
}
"""
Cancels orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderBulkCancel {
"""Returns how many objects were affected."""
count: Int!
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Cancel an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderCancel {
"""Canceled order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Event sent when order is canceled.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderCancelled implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""
Capture an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderCapture {
"""Captured order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Determine the current charge status for the order.
We treat the order as overcharged when the charged amount is bigger that order.total
We treat the order as fully charged when the charged amount is equal to order.total.
We treat the order as partially charged when the charged amount covers only part of
the order.total
NONE - the funds are not charged.
PARTIAL - the funds that are charged don't cover the order's total
FULL - the funds that are charged fully cover the order's total
OVERCHARGED - the charged funds are bigger than order's total
"""
enum OrderChargeStatusEnum {
NONE
PARTIAL
FULL
OVERCHARGED
}
"""
Confirms an unconfirmed order by changing status to unfulfilled.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderConfirm {
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Event sent when order is confirmed.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderConfirmed implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
type OrderCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [OrderCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type OrderCountableEdge {
"""The item at the end of the edge."""
node: Order!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderCreateFromCheckout {
"""Placed order."""
order: Order
errors: [OrderCreateFromCheckoutError!]!
}
type OrderCreateFromCheckoutError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: OrderCreateFromCheckoutErrorCode!
"""List of variant IDs which causes the error."""
variants: [ID!]
"""List of line Ids which cause the error."""
lines: [ID!]
}
"""An enumeration."""
enum OrderCreateFromCheckoutErrorCode {
GRAPHQL_ERROR
CHECKOUT_NOT_FOUND
CHANNEL_INACTIVE
INSUFFICIENT_STOCK
VOUCHER_NOT_APPLICABLE
GIFT_CARD_NOT_APPLICABLE
TAX_ERROR
SHIPPING_METHOD_NOT_SET
BILLING_ADDRESS_NOT_SET
SHIPPING_ADDRESS_NOT_SET
INVALID_SHIPPING_METHOD
NO_LINES
EMAIL_NOT_SET
UNAVAILABLE_VARIANT_IN_CHANNEL
}
"""
Event sent when new order is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
enum OrderDirection {
"""Specifies an ascending sort order."""
ASC
"""Specifies a descending sort order."""
DESC
}
"""Contains all details related to the applied discount to the order."""
type OrderDiscount implements Node {
id: ID!
type: OrderDiscountType!
name: String
translatedName: String
"""Type of the discount: fixed or percent"""
valueType: DiscountValueTypeEnum!
"""Value of the discount. Can store fixed value or percent value"""
value: PositiveDecimal!
"""
Explanation for the applied discount.
Requires one of the following permissions: MANAGE_ORDERS.
"""
reason: String
"""Returns amount of discount."""
amount: Money!
}
"""
Adds discount to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderDiscountAdd {
"""Order which has been discounted."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input OrderDiscountCommonInput {
"""Type of the discount: fixed or percent"""
valueType: DiscountValueTypeEnum!
"""Value of the discount. Can store fixed value or percent value"""
value: PositiveDecimal!
"""Explanation for the applied discount."""
reason: String
}
"""
Remove discount from the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderDiscountDelete {
"""Order which has removed discount."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""An enumeration."""
enum OrderDiscountType {
VOUCHER
MANUAL
}
"""
Update discount for the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderDiscountUpdate {
"""Order which has been discounted."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input OrderDraftFilterInput {
customer: String
created: DateRangeInput
search: String
metadata: [MetadataFilter!]
channels: [ID!]
}
type OrderError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: OrderErrorCode!
"""Warehouse ID which causes the error."""
warehouse: ID
"""List of order line IDs that cause the error."""
orderLines: [ID!]
"""List of product variants that are associated with the error"""
variants: [ID!]
"""A type of address that causes the error."""
addressType: AddressTypeEnum
}
"""An enumeration."""
enum OrderErrorCode {
BILLING_ADDRESS_NOT_SET
CANNOT_CANCEL_FULFILLMENT
CANNOT_CANCEL_ORDER
CANNOT_DELETE
CANNOT_DISCOUNT
CANNOT_REFUND
CANNOT_FULFILL_UNPAID_ORDER
CAPTURE_INACTIVE_PAYMENT
GIFT_CARD_LINE
NOT_EDITABLE
FULFILL_ORDER_LINE
GRAPHQL_ERROR
INVALID
PRODUCT_NOT_PUBLISHED
PRODUCT_UNAVAILABLE_FOR_PURCHASE
NOT_FOUND
ORDER_NO_SHIPPING_ADDRESS
PAYMENT_ERROR
PAYMENT_MISSING
REQUIRED
SHIPPING_METHOD_NOT_APPLICABLE
SHIPPING_METHOD_REQUIRED
TAX_ERROR
UNIQUE
VOID_INACTIVE_PAYMENT
ZERO_QUANTITY
INVALID_QUANTITY
INSUFFICIENT_STOCK
DUPLICATED_INPUT_ITEM
NOT_AVAILABLE_IN_CHANNEL
CHANNEL_INACTIVE
MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK
}
"""History log of the order."""
type OrderEvent implements Node {
id: ID!
"""Date when event happened at in ISO 8601 format."""
date: DateTime
"""Order event type."""
type: OrderEventsEnum
"""User who performed the action."""
user: User
"""
App that performed the action. Requires of of the following permissions: MANAGE_APPS, MANAGE_ORDERS, OWNER.
"""
app: App
"""Content of the event."""
message: String
"""Email of the customer."""
email: String
"""Type of an email sent to the customer."""
emailType: OrderEventsEmailsEnum
"""Amount of money."""
amount: Float
"""The payment reference from the payment provider."""
paymentId: String
"""The payment gateway of the payment."""
paymentGateway: String
"""Number of items."""
quantity: Int
"""Composed ID of the Fulfillment."""
composedId: String
"""User-friendly number of an order."""
orderNumber: String
"""Number of an invoice related to the order."""
invoiceNumber: String
"""List of oversold lines names."""
oversoldItems: [String!]
"""The concerned lines."""
lines: [OrderEventOrderLineObject!]
"""The lines fulfilled."""
fulfilledItems: [FulfillmentLine!]
"""The warehouse were items were restocked."""
warehouse: Warehouse
"""The transaction reference of captured payment."""
transactionReference: String
"""Define if shipping costs were included to the refund."""
shippingCostsIncluded: Boolean
"""The order which is related to this order."""
relatedOrder: Order
"""The discount applied to the order."""
discount: OrderEventDiscountObject
"""The status of payment's transaction."""
status: TransactionStatus
"""The reference of payment's transaction."""
reference: String
}
type OrderEventCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [OrderEventCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type OrderEventCountableEdge {
"""The item at the end of the edge."""
node: OrderEvent!
"""A cursor for use in pagination."""
cursor: String!
}
type OrderEventDiscountObject {
"""Type of the discount: fixed or percent."""
valueType: DiscountValueTypeEnum!
"""Value of the discount. Can store fixed value or percent value."""
value: PositiveDecimal!
"""Explanation for the applied discount."""
reason: String
"""Returns amount of discount."""
amount: Money
"""Type of the discount: fixed or percent."""
oldValueType: DiscountValueTypeEnum
"""Value of the discount. Can store fixed value or percent value."""
oldValue: PositiveDecimal
"""Returns amount of discount."""
oldAmount: Money
}
type OrderEventOrderLineObject {
"""The variant quantity."""
quantity: Int
"""The order line."""
orderLine: OrderLine
"""The variant name."""
itemName: String
"""The discount applied to the order line."""
discount: OrderEventDiscountObject
}
"""An enumeration."""
enum OrderEventsEmailsEnum {
PAYMENT_CONFIRMATION
CONFIRMED
SHIPPING_CONFIRMATION
TRACKING_UPDATED
ORDER_CONFIRMATION
ORDER_CANCEL
ORDER_REFUND
FULFILLMENT_CONFIRMATION
DIGITAL_LINKS
}
"""An enumeration."""
enum OrderEventsEnum {
DRAFT_CREATED
DRAFT_CREATED_FROM_REPLACE
ADDED_PRODUCTS
REMOVED_PRODUCTS
PLACED
PLACED_FROM_DRAFT
OVERSOLD_ITEMS
CANCELED
ORDER_MARKED_AS_PAID
ORDER_FULLY_PAID
ORDER_REPLACEMENT_CREATED
ORDER_DISCOUNT_ADDED
ORDER_DISCOUNT_AUTOMATICALLY_UPDATED
ORDER_DISCOUNT_UPDATED
ORDER_DISCOUNT_DELETED
ORDER_LINE_DISCOUNT_UPDATED
ORDER_LINE_DISCOUNT_REMOVED
ORDER_LINE_PRODUCT_DELETED
ORDER_LINE_VARIANT_DELETED
UPDATED_ADDRESS
EMAIL_SENT
CONFIRMED
PAYMENT_AUTHORIZED
PAYMENT_CAPTURED
EXTERNAL_SERVICE_NOTIFICATION
PAYMENT_REFUNDED
PAYMENT_VOIDED
PAYMENT_FAILED
TRANSACTION_EVENT
TRANSACTION_CAPTURE_REQUESTED
TRANSACTION_REFUND_REQUESTED
TRANSACTION_VOID_REQUESTED
INVOICE_REQUESTED
INVOICE_GENERATED
INVOICE_UPDATED
INVOICE_SENT
FULFILLMENT_CANCELED
FULFILLMENT_RESTOCKED_ITEMS
FULFILLMENT_FULFILLED_ITEMS
FULFILLMENT_REFUNDED
FULFILLMENT_RETURNED
FULFILLMENT_REPLACED
FULFILLMENT_AWAITS_APPROVAL
TRACKING_UPDATED
NOTE_ADDED
OTHER
}
input OrderFilterInput {
paymentStatus: [PaymentChargeStatusEnum!]
status: [OrderStatusFilter!]
customer: String
created: DateRangeInput
search: String
metadata: [MetadataFilter!]
channels: [ID!]
authorizeStatus: [OrderAuthorizeStatusEnum!]
chargeStatus: [OrderChargeStatusEnum!]
updatedAt: DateTimeRangeInput
isClickAndCollect: Boolean
isPreorder: Boolean
ids: [ID!]
giftCardUsed: Boolean
giftCardBought: Boolean
numbers: [String!]
}
"""
Filter shipping methods for order.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderFilterShippingMethods implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
"""
Shipping methods that can be used with this checkout.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
shippingMethods: [ShippingMethod!]
}
"""
Creates new fulfillments for an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderFulfill {
"""List of created fulfillments."""
fulfillments: [Fulfillment!]
"""Fulfilled order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input OrderFulfillInput {
"""List of items informing how to fulfill the order."""
lines: [OrderFulfillLineInput!]!
"""If true, send an email notification to the customer."""
notifyCustomer: Boolean
"""If true, then allow proceed fulfillment when stock is exceeded."""
allowStockToBeExceeded: Boolean = false
"""
Fulfillment tracking number.
Added in Saleor 3.6.
"""
trackingNumber: String
}
input OrderFulfillLineInput {
"""The ID of the order line."""
orderLineId: ID
"""List of stock items to create."""
stocks: [OrderFulfillStockInput!]!
}
input OrderFulfillStockInput {
"""The number of line items to be fulfilled from given warehouse."""
quantity: Int!
"""ID of the warehouse from which the item will be fulfilled."""
warehouse: ID!
}
"""
Event sent when order is fulfilled.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderFulfilled implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""
Event sent when order is fully paid.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderFullyPaid implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""Represents order line of particular order."""
type OrderLine implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
productName: String!
variantName: String!
productSku: String
productVariantId: String
isShippingRequired: Boolean!
quantity: Int!
quantityFulfilled: Int!
unitDiscountReason: String
taxRate: Float!
digitalContentUrl: DigitalContentUrl
thumbnail(
"""
Size of the image. If not provided, the original image will be returned.
"""
size: Int
"""
The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
format: ThumbnailFormatEnum
): Image
"""Price of the single item in the order line."""
unitPrice: TaxedMoney!
"""
Price of the single item in the order line without applied an order line discount.
"""
undiscountedUnitPrice: TaxedMoney!
"""The discount applied to the single order line."""
unitDiscount: Money!
"""Value of the discount. Can store fixed value or percent value"""
unitDiscountValue: PositiveDecimal!
"""Price of the order line."""
totalPrice: TaxedMoney!
"""
A purchased product variant. Note: this field may be null if the variant has been removed from stock at all. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
variant: ProductVariant
"""Product name in the customer's language"""
translatedProductName: String!
"""Variant name in the customer's language"""
translatedVariantName: String!
"""
List of allocations across warehouses.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
allocations: [Allocation!]
"""
A quantity of items remaining to be fulfilled.
Added in Saleor 3.1.
"""
quantityToFulfill: Int!
"""Type of the discount: fixed or percent"""
unitDiscountType: DiscountValueTypeEnum
"""
Denormalized tax class of the product in this order line.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
taxClass: TaxClass
"""
Denormalized name of the tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
taxClassName: String
"""
Denormalized public metadata of the tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
taxClassMetadata: [MetadataItem!]!
"""
Denormalized private metadata of the tax class. Requires staff permissions to access.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
taxClassPrivateMetadata: [MetadataItem!]!
}
input OrderLineCreateInput {
"""Number of variant items ordered."""
quantity: Int!
"""Product variant ID."""
variantId: ID!
"""
Flag that allow force splitting the same variant into multiple lines by skipping the matching logic.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
forceNewLine: Boolean = false
}
"""
Deletes an order line from an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderLineDelete {
"""A related order."""
order: Order
"""An order line that was deleted."""
orderLine: OrderLine
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Remove discount applied to the order line.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderLineDiscountRemove {
"""Order line which has removed discount."""
orderLine: OrderLine
"""Order which is related to line which has removed discount."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Update discount for the order line.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderLineDiscountUpdate {
"""Order line which has been discounted."""
orderLine: OrderLine
"""Order which is related to the discounted line."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input OrderLineInput {
"""Number of variant items ordered."""
quantity: Int!
}
"""
Updates an order line of an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderLineUpdate {
"""Related order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
orderLine: OrderLine
}
"""
Create order lines for an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderLinesCreate {
"""Related order."""
order: Order
"""List of added order lines."""
orderLines: [OrderLine!]
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Mark order as manually paid.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderMarkAsPaid {
"""Order marked as paid."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
Event sent when order metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""An enumeration."""
enum OrderOriginEnum {
CHECKOUT
DRAFT
REISSUE
}
"""
Refund an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderRefund {
"""A refunded order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input OrderRefundFulfillmentLineInput {
"""The ID of the fulfillment line to refund."""
fulfillmentLineId: ID!
"""The number of items to be refunded."""
quantity: Int!
}
input OrderRefundLineInput {
"""The ID of the order line to refund."""
orderLineId: ID!
"""The number of items to be refunded."""
quantity: Int!
}
input OrderRefundProductsInput {
"""List of unfulfilled lines to refund."""
orderLines: [OrderRefundLineInput!]
"""List of fulfilled lines to refund."""
fulfillmentLines: [OrderRefundFulfillmentLineInput!]
"""The total amount of refund when the value is provided manually."""
amountToRefund: PositiveDecimal
"""
If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored.
"""
includeShippingCosts: Boolean = false
}
input OrderReturnFulfillmentLineInput {
"""The ID of the fulfillment line to return."""
fulfillmentLineId: ID!
"""The number of items to be returned."""
quantity: Int!
"""Determines, if the line should be added to replace order."""
replace: Boolean = false
}
input OrderReturnLineInput {
"""The ID of the order line to return."""
orderLineId: ID!
"""The number of items to be returned."""
quantity: Int!
"""Determines, if the line should be added to replace order."""
replace: Boolean = false
}
input OrderReturnProductsInput {
"""List of unfulfilled lines to return."""
orderLines: [OrderReturnLineInput!]
"""List of fulfilled lines to return."""
fulfillmentLines: [OrderReturnFulfillmentLineInput!]
"""The total amount of refund when the value is provided manually."""
amountToRefund: PositiveDecimal
"""
If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored.
"""
includeShippingCosts: Boolean = false
"""If true, Saleor will call refund action for all lines."""
refund: Boolean = false
}
"""Order related settings from site settings."""
type OrderSettings {
automaticallyConfirmAllNewOrders: Boolean!
automaticallyFulfillNonShippableGiftCard: Boolean!
}
type OrderSettingsError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: OrderSettingsErrorCode!
}
"""An enumeration."""
enum OrderSettingsErrorCode {
INVALID
}
"""
Update shop order settings.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderSettingsUpdate {
"""Order settings."""
orderSettings: OrderSettings
orderSettingsErrors: [OrderSettingsError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderSettingsError!]!
}
input OrderSettingsUpdateInput {
"""
When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately.
"""
automaticallyConfirmAllNewOrders: Boolean
"""
When enabled, all non-shippable gift card orders will be fulfilled automatically.
"""
automaticallyFulfillNonShippableGiftCard: Boolean
}
enum OrderSortField {
"""Sort orders by number."""
NUMBER
"""
Sort orders by rank. Note: This option is available only with the `search` filter.
"""
RANK
"""
Sort orders by creation date.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
CREATION_DATE
"""
Sort orders by creation date.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
CREATED_AT
"""Sort orders by last modified at."""
LAST_MODIFIED_AT
"""Sort orders by customer."""
CUSTOMER
"""Sort orders by payment."""
PAYMENT
"""Sort orders by fulfillment status."""
FULFILLMENT_STATUS
}
input OrderSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort orders by the selected field."""
field: OrderSortField!
}
"""An enumeration."""
enum OrderStatus {
DRAFT
UNCONFIRMED
UNFULFILLED
PARTIALLY_FULFILLED
PARTIALLY_RETURNED
RETURNED
FULFILLED
CANCELED
}
enum OrderStatusFilter {
READY_TO_FULFILL
READY_TO_CAPTURE
UNFULFILLED
UNCONFIRMED
PARTIALLY_FULFILLED
FULFILLED
CANCELED
}
"""
Updates an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderUpdate {
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
order: Order
}
input OrderUpdateInput {
"""Billing address of the customer."""
billingAddress: AddressInput
"""Email address of the customer."""
userEmail: String
"""Shipping address of the customer."""
shippingAddress: AddressInput
}
"""
Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderUpdateShipping {
"""Order with updated shipping method."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
input OrderUpdateShippingInput {
"""
ID of the selected shipping method, pass null to remove currently assigned shipping method.
"""
shippingMethod: ID
}
"""
Event sent when order is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""
Event sent when order is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type OrderUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The order the event relates to."""
order: Order
}
"""
Void an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type OrderVoid {
"""A voided order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [OrderError!]!
}
"""
A static page that can be manually added by a shop operator through the dashboard.
"""
type Page implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
seoTitle: String
seoDescription: String
title: String!
"""
Content of the page.
Rich text format. For reference see https://editorjs.io/
"""
content: JSONString
publicationDate: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date.")
"""
The page publication date.
Added in Saleor 3.3.
"""
publishedAt: DateTime
isPublished: Boolean!
slug: String!
pageType: PageType!
created: DateTime!
"""
Content of the page.
Rich text format. For reference see https://editorjs.io/
"""
contentJson: JSONString! @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `content` field instead.")
"""Returns translated page fields for the given language code."""
translation(
"""A language code to return the translation for page."""
languageCode: LanguageCodeEnum!
): PageTranslation
"""List of attributes assigned to this product."""
attributes: [SelectedAttribute!]!
}
"""
Assign attributes to a given page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type PageAttributeAssign {
"""The updated page type."""
pageType: PageType
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
}
"""
Unassign attributes from a given page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type PageAttributeUnassign {
"""The updated page type."""
pageType: PageType
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
}
"""
Deletes pages.
Requires one of the following permissions: MANAGE_PAGES.
"""
type PageBulkDelete {
"""Returns how many objects were affected."""
count: Int!
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
}
"""
Publish pages.
Requires one of the following permissions: MANAGE_PAGES.
"""
type PageBulkPublish {
"""Returns how many objects were affected."""
count: Int!
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
}
type PageCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PageCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type PageCountableEdge {
"""The item at the end of the edge."""
node: Page!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new page.
Requires one of the following permissions: MANAGE_PAGES.
"""
type PageCreate {
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
page: Page
}
input PageCreateInput {
"""Page internal name."""
slug: String
"""Page title."""
title: String
"""
Page content.
Rich text format. For reference see https://editorjs.io/
"""
content: JSONString
"""List of attributes."""
attributes: [AttributeValueInput!]
"""Determines if page is visible in the storefront."""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.
"""
publicationDate: String
"""
Publication date time. ISO 8601 standard.
Added in Saleor 3.3.
"""
publishedAt: DateTime
"""Search engine optimization fields."""
seo: SeoInput
"""ID of the page type that page belongs to."""
pageType: ID!
}
"""
Event sent when new page is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PageCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The page the event relates to."""
page: Page
}
"""
Event sent when new page is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PageCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The page the event relates to."""
page: Page
}
"""
Deletes a page.
Requires one of the following permissions: MANAGE_PAGES.
"""
type PageDelete {
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
page: Page
}
"""
Event sent when page is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PageDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The page the event relates to."""
page: Page
}
type PageError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: PageErrorCode!
"""List of attributes IDs which causes the error."""
attributes: [ID!]
"""List of attribute values IDs which causes the error."""
values: [ID!]
}
"""An enumeration."""
enum PageErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
DUPLICATED_INPUT_ITEM
ATTRIBUTE_ALREADY_ASSIGNED
}
input PageFilterInput {
search: String
metadata: [MetadataFilter!]
pageTypes: [ID!]
ids: [ID!]
slugs: [String!]
}
"""
The Relay compliant `PageInfo` type, containing data necessary to paginate this connection.
"""
type PageInfo {
"""When paginating forwards, are there more items?"""
hasNextPage: Boolean!
"""When paginating backwards, are there more items?"""
hasPreviousPage: Boolean!
"""When paginating backwards, the cursor to continue."""
startCursor: String
"""When paginating forwards, the cursor to continue."""
endCursor: String
}
input PageInput {
"""Page internal name."""
slug: String
"""Page title."""
title: String
"""
Page content.
Rich text format. For reference see https://editorjs.io/
"""
content: JSONString
"""List of attributes."""
attributes: [AttributeValueInput!]
"""Determines if page is visible in the storefront."""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.
"""
publicationDate: String
"""
Publication date time. ISO 8601 standard.
Added in Saleor 3.3.
"""
publishedAt: DateTime
"""Search engine optimization fields."""
seo: SeoInput
}
"""
Reorder page attribute values.
Requires one of the following permissions: MANAGE_PAGES.
"""
type PageReorderAttributeValues {
"""Page from which attribute values are reordered."""
page: Page
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
}
enum PageSortField {
"""Sort pages by title."""
TITLE
"""Sort pages by slug."""
SLUG
"""Sort pages by visibility."""
VISIBILITY
"""
Sort pages by creation date.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
CREATION_DATE
"""
Sort pages by publication date.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
PUBLICATION_DATE
"""
Sort pages by publication date.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
PUBLISHED_AT
"""
Sort pages by creation date.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
CREATED_AT
}
input PageSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort pages by the selected field."""
field: PageSortField!
}
type PageTranslatableContent implements Node {
id: ID!
seoTitle: String
seoDescription: String
title: String!
"""
Content of the page.
Rich text format. For reference see https://editorjs.io/
"""
content: JSONString
"""
Content of the page.
Rich text format. For reference see https://editorjs.io/
"""
contentJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `content` field instead.")
"""Returns translated page fields for the given language code."""
translation(
"""A language code to return the translation for page."""
languageCode: LanguageCodeEnum!
): PageTranslation
"""
A static page that can be manually added by a shop operator through the dashboard.
"""
page: Page @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
"""List of page content attribute values that can be translated."""
attributeValues: [AttributeValueTranslatableContent!]!
}
"""
Creates/updates translations for a page.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type PageTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
page: PageTranslatableContent
}
type PageTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
seoTitle: String
seoDescription: String
title: String
"""
Translated content of the page.
Rich text format. For reference see https://editorjs.io/
"""
content: JSONString
"""
Translated description of the page.
Rich text format. For reference see https://editorjs.io/
"""
contentJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `content` field instead.")
}
input PageTranslationInput {
seoTitle: String
seoDescription: String
title: String
"""
Translated page content.
Rich text format. For reference see https://editorjs.io/
"""
content: JSONString
}
"""
Represents a type of page. It defines what attributes are available to pages of this type.
"""
type PageType implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
slug: String!
"""Page attributes of that page type."""
attributes: [Attribute!]
"""
Attributes that can be assigned to the page type.
Requires one of the following permissions: MANAGE_PAGES.
"""
availableAttributes(
filter: AttributeFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): AttributeCountableConnection
"""
Whether page type has pages assigned.
Requires one of the following permissions: MANAGE_PAGES.
"""
hasPages: Boolean
}
"""
Delete page types.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type PageTypeBulkDelete {
"""Returns how many objects were affected."""
count: Int!
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
}
type PageTypeCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PageTypeCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type PageTypeCountableEdge {
"""The item at the end of the edge."""
node: PageType!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Create a new page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type PageTypeCreate {
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
pageType: PageType
}
input PageTypeCreateInput {
"""Name of the page type."""
name: String
"""Page type slug."""
slug: String
"""List of attribute IDs to be assigned to the page type."""
addAttributes: [ID!]
}
"""
Event sent when new page type is created.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PageTypeCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The page type the event relates to."""
pageType: PageType
}
"""
Delete a page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type PageTypeDelete {
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
pageType: PageType
}
"""
Event sent when page type is deleted.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PageTypeDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The page type the event relates to."""
pageType: PageType
}
input PageTypeFilterInput {
search: String
slugs: [String!]
}
"""
Reorder the attributes of a page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type PageTypeReorderAttributes {
"""Page type from which attributes are reordered."""
pageType: PageType
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
}
enum PageTypeSortField {
"""Sort page types by name."""
NAME
"""Sort page types by slug."""
SLUG
}
input PageTypeSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort page types by the selected field."""
field: PageTypeSortField!
}
"""
Update page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
type PageTypeUpdate {
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
pageType: PageType
}
input PageTypeUpdateInput {
"""Name of the page type."""
name: String
"""Page type slug."""
slug: String
"""List of attribute IDs to be assigned to the page type."""
addAttributes: [ID!]
"""List of attribute IDs to be assigned to the page type."""
removeAttributes: [ID!]
}
"""
Event sent when page type is updated.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PageTypeUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The page type the event relates to."""
pageType: PageType
}
"""
Updates an existing page.
Requires one of the following permissions: MANAGE_PAGES.
"""
type PageUpdate {
pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PageError!]!
page: Page
}
"""
Event sent when page is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PageUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The page the event relates to."""
page: Page
}
"""
Change the password of the logged in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type PasswordChange {
"""A user instance with a new password."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""Represents a payment of a given type."""
type Payment implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
gateway: String!
isActive: Boolean!
created: DateTime!
modified: DateTime!
token: String!
checkout: Checkout
order: Order
paymentMethodType: String!
"""
IP address of the user who created the payment.
Requires one of the following permissions: MANAGE_ORDERS.
"""
customerIpAddress: String
"""Internal payment status."""
chargeStatus: PaymentChargeStatusEnum!
"""
List of actions that can be performed in the current state of a payment.
Requires one of the following permissions: MANAGE_ORDERS.
"""
actions: [OrderAction!]!
"""Total amount of the payment."""
total: Money
"""Total amount captured for this payment."""
capturedAmount: Money
"""
List of all transactions within this payment.
Requires one of the following permissions: MANAGE_ORDERS.
"""
transactions: [Transaction!]
"""
Maximum amount of money that can be captured.
Requires one of the following permissions: MANAGE_ORDERS.
"""
availableCaptureAmount: Money
"""
Maximum amount of money that can be refunded.
Requires one of the following permissions: MANAGE_ORDERS.
"""
availableRefundAmount: Money
"""The details of the card used for this payment."""
creditCard: CreditCard
}
"""
Authorize payment.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PaymentAuthorize implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""Look up a payment."""
payment: Payment
}
"""
Captures the authorized payment amount.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type PaymentCapture {
"""Updated payment."""
payment: Payment
paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PaymentError!]!
}
"""
Capture payment.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PaymentCaptureEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""Look up a payment."""
payment: Payment
}
"""An enumeration."""
enum PaymentChargeStatusEnum {
NOT_CHARGED
PENDING
PARTIALLY_CHARGED
FULLY_CHARGED
PARTIALLY_REFUNDED
FULLY_REFUNDED
REFUSED
CANCELLED
}
"""Check payment balance."""
type PaymentCheckBalance {
"""Response from the gateway."""
data: JSONString
paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PaymentError!]!
}
input PaymentCheckBalanceInput {
"""An ID of a payment gateway to check."""
gatewayId: String!
"""Payment method name."""
method: String!
"""Slug of a channel for which the data should be returned."""
channel: String!
"""Information about card."""
card: CardInput!
}
"""
Confirm payment.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PaymentConfirmEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""Look up a payment."""
payment: Payment
}
type PaymentCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PaymentCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type PaymentCountableEdge {
"""The item at the end of the edge."""
node: Payment!
"""A cursor for use in pagination."""
cursor: String!
}
type PaymentError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: PaymentErrorCode!
"""List of variant IDs which causes the error."""
variants: [ID!]
}
"""An enumeration."""
enum PaymentErrorCode {
BILLING_ADDRESS_NOT_SET
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
PARTIAL_PAYMENT_NOT_ALLOWED
SHIPPING_ADDRESS_NOT_SET
INVALID_SHIPPING_METHOD
SHIPPING_METHOD_NOT_SET
PAYMENT_ERROR
NOT_SUPPORTED_GATEWAY
CHANNEL_INACTIVE
BALANCE_CHECK_ERROR
CHECKOUT_EMAIL_NOT_SET
UNAVAILABLE_VARIANT_IN_CHANNEL
NO_CHECKOUT_LINES
}
input PaymentFilterInput {
"""
Filter by ids.
Added in Saleor 3.8.
"""
ids: [ID!]
checkouts: [ID!]
}
"""
Available payment gateway backend with configuration necessary to setup client.
"""
type PaymentGateway {
"""Payment gateway name."""
name: String!
"""Payment gateway ID."""
id: ID!
"""Payment gateway client configuration."""
config: [GatewayConfigLine!]!
"""Payment gateway supported currencies."""
currencies: [String!]!
}
"""Initializes payment process when it is required by gateway."""
type PaymentInitialize {
initializedPayment: PaymentInitialized
paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PaymentError!]!
}
"""
Server-side data generated by a payment gateway. Optional step when the payment provider requires an additional action to initialize payment session.
"""
type PaymentInitialized {
"""ID of a payment gateway."""
gateway: String!
"""Payment gateway name."""
name: String!
"""Initialized data by gateway."""
data: JSONString
}
input PaymentInput {
"""A gateway to use with that payment."""
gateway: String!
"""
Client-side generated payment token, representing customer's billing data in a secure manner.
"""
token: String
"""
Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used.
"""
amount: PositiveDecimal
"""
URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided.
"""
returnUrl: String
"""
Payment store type.
Added in Saleor 3.1.
"""
storePaymentMethod: StorePaymentMethodEnum
"""
User public metadata.
Added in Saleor 3.1.
"""
metadata: [MetadataInput!]
}
"""
List payment gateways.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PaymentListGateways implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The checkout the event relates to."""
checkout: Checkout
}
"""
Process payment.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PaymentProcessEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""Look up a payment."""
payment: Payment
}
"""
Refunds the captured payment amount.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type PaymentRefund {
"""Updated payment."""
payment: Payment
paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PaymentError!]!
}
"""
Refund payment.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PaymentRefundEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""Look up a payment."""
payment: Payment
}
"""
Represents a payment source stored for user in payment gateway, such as credit card.
"""
type PaymentSource {
"""Payment gateway name."""
gateway: String!
"""ID of stored payment method."""
paymentMethodId: String
"""Stored credit card details if available."""
creditCardInfo: CreditCard
"""
List of public metadata items.
Added in Saleor 3.1.
Can be accessed without permissions.
"""
metadata: [MetadataItem!]!
}
"""
Voids the authorized payment.
Requires one of the following permissions: MANAGE_ORDERS.
"""
type PaymentVoid {
"""Updated payment."""
payment: Payment
paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PaymentError!]!
}
"""
Void payment.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PaymentVoidEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""Look up a payment."""
payment: Payment
}
"""Represents a permission object in a friendly form."""
type Permission {
"""Internal code for permission."""
code: PermissionEnum!
"""Describe action(s) allowed to do by permission."""
name: String!
}
"""An enumeration."""
enum PermissionEnum {
MANAGE_USERS
MANAGE_STAFF
IMPERSONATE_USER
MANAGE_APPS
MANAGE_OBSERVABILITY
MANAGE_CHECKOUTS
HANDLE_CHECKOUTS
HANDLE_TAXES
MANAGE_TAXES
MANAGE_CHANNELS
MANAGE_CHECKOUTS
HANDLE_CHECKOUTS
HANDLE_TAXES
MANAGE_TAXES
MANAGE_CHANNELS
MANAGE_DISCOUNTS
MANAGE_GIFT_CARD
MANAGE_MENUS
MANAGE_ORDERS
MANAGE_PAGES
MANAGE_PAGE_TYPES_AND_ATTRIBUTES
HANDLE_PAYMENTS
MANAGE_PLUGINS
MANAGE_PRODUCTS
MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES
MANAGE_SHIPPING
MANAGE_SETTINGS
MANAGE_TRANSLATIONS
}
"""
Create new permission group. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
type PermissionGroupCreate {
permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PermissionGroupError!]!
group: Group
}
input PermissionGroupCreateInput {
"""List of permission code names to assign to this group."""
addPermissions: [PermissionEnum!]
"""List of users to assign to this group."""
addUsers: [ID!]
"""Group name."""
name: String!
}
"""
Event sent when new permission group is created.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PermissionGroupCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The permission group the event relates to."""
permissionGroup: Group
}
"""
Delete permission group. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
type PermissionGroupDelete {
permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PermissionGroupError!]!
group: Group
}
"""
Event sent when permission group is deleted.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PermissionGroupDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The permission group the event relates to."""
permissionGroup: Group
}
type PermissionGroupError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: PermissionGroupErrorCode!
"""List of permissions which causes the error."""
permissions: [PermissionEnum!]
"""List of user IDs which causes the error."""
users: [ID!]
}
"""An enumeration."""
enum PermissionGroupErrorCode {
ASSIGN_NON_STAFF_MEMBER
DUPLICATED_INPUT_ITEM
CANNOT_REMOVE_FROM_LAST_GROUP
LEFT_NOT_MANAGEABLE_PERMISSION
OUT_OF_SCOPE_PERMISSION
OUT_OF_SCOPE_USER
REQUIRED
UNIQUE
}
input PermissionGroupFilterInput {
search: String
ids: [ID!]
}
enum PermissionGroupSortField {
"""Sort permission group accounts by name."""
NAME
}
input PermissionGroupSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort permission group by the selected field."""
field: PermissionGroupSortField!
}
"""
Update permission group. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
type PermissionGroupUpdate {
permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PermissionGroupError!]!
group: Group
}
input PermissionGroupUpdateInput {
"""List of permission code names to assign to this group."""
addPermissions: [PermissionEnum!]
"""List of users to assign to this group."""
addUsers: [ID!]
"""Group name."""
name: String
"""List of permission code names to unassign from this group."""
removePermissions: [PermissionEnum!]
"""List of users to unassign from this group."""
removeUsers: [ID!]
}
"""
Event sent when permission group is updated.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type PermissionGroupUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The permission group the event relates to."""
permissionGroup: Group
}
"""Plugin."""
type Plugin {
"""Identifier of the plugin."""
id: ID!
"""Name of the plugin."""
name: String!
"""Description of the plugin."""
description: String!
"""Global configuration of the plugin (not channel-specific)."""
globalConfiguration: PluginConfiguration
"""Channel-specific plugin configuration."""
channelConfigurations: [PluginConfiguration!]!
}
"""Stores information about a configuration of plugin."""
type PluginConfiguration {
"""Determines if plugin is active or not."""
active: Boolean!
"""The channel to which the plugin configuration is assigned to."""
channel: Channel
"""Configuration of the plugin."""
configuration: [ConfigurationItem!]
}
enum PluginConfigurationType {
PER_CHANNEL
GLOBAL
}
type PluginCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PluginCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type PluginCountableEdge {
"""The item at the end of the edge."""
node: Plugin!
"""A cursor for use in pagination."""
cursor: String!
}
type PluginError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: PluginErrorCode!
}
"""An enumeration."""
enum PluginErrorCode {
GRAPHQL_ERROR
INVALID
PLUGIN_MISCONFIGURED
NOT_FOUND
REQUIRED
UNIQUE
}
input PluginFilterInput {
statusInChannels: PluginStatusInChannelsInput
search: String
type: PluginConfigurationType
}
enum PluginSortField {
NAME
IS_ACTIVE
}
input PluginSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort plugins by the selected field."""
field: PluginSortField!
}
input PluginStatusInChannelsInput {
active: Boolean!
channels: [ID!]!
}
"""
Update plugin configuration.
Requires one of the following permissions: MANAGE_PLUGINS.
"""
type PluginUpdate {
plugin: Plugin
pluginsErrors: [PluginError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [PluginError!]!
}
input PluginUpdateInput {
"""Indicates whether the plugin should be enabled."""
active: Boolean
"""Configuration of the plugin."""
configuration: [ConfigurationItemInput!]
}
"""
Positive Decimal scalar implementation.
Should be used in places where value must be positive.
"""
scalar PositiveDecimal
"""An enumeration."""
enum PostalCodeRuleInclusionTypeEnum {
INCLUDE
EXCLUDE
}
"""Represents preorder settings for product variant."""
type PreorderData {
"""
The global preorder threshold for product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
globalThreshold: Int
"""
Total number of sold product variant during preorder.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
globalSoldUnits: Int!
"""Preorder end date."""
endDate: DateTime
}
input PreorderSettingsInput {
"""The global threshold for preorder variant."""
globalThreshold: Int
"""The end date for preorder."""
endDate: DateTime
}
"""Represents preorder variant data for channel."""
type PreorderThreshold {
"""Preorder threshold for product variant in this channel."""
quantity: Int
"""Number of sold product variant in this channel."""
soldUnits: Int!
}
input PriceInput {
"""Currency code."""
currency: String!
"""Amount of money."""
amount: PositiveDecimal!
}
input PriceRangeInput {
"""Price greater than or equal to."""
gte: Float
"""Price less than or equal to."""
lte: Float
}
"""Represents an individual item for sale in the storefront."""
type Product implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
seoTitle: String
seoDescription: String
name: String!
"""
Description of the product.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
productType: ProductType!
slug: String!
category: Category
created: DateTime!
updatedAt: DateTime!
chargeTaxes: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` field to determine whether tax collection is enabled.")
weight: Weight
defaultVariant: ProductVariant
rating: Float
"""
Channel given to retrieve this product. Also used by federation gateway to resolve this object in a federated query.
"""
channel: String
"""
Description of the product.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
thumbnail(
"""
Size of the image. If not provided, the original image will be returned.
"""
size: Int
"""
The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
format: ThumbnailFormatEnum
): Image
"""
Lists the storefront product's pricing, the current price and discounts, only meant for displaying.
"""
pricing(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): ProductPricingInfo
"""Whether the product is in stock and visible or not."""
isAvailable(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): Boolean
"""A type of tax. Assigned by enabled tax gateway"""
taxType: TaxType @deprecated(reason: "This field will be removed in Saleor 4.0. Use `taxClass` field instead.")
"""List of attributes assigned to this product."""
attributes: [SelectedAttribute!]!
"""
List of availability in channels for the product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
channelListings: [ProductChannelListing!]
"""Get a single product media by ID."""
mediaById(
"""ID of a product media."""
id: ID
): ProductMedia
"""Get a single product image by ID."""
imageById(
"""ID of a product image."""
id: ID
): ProductImage @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `mediaById` field instead.")
"""
List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
variants: [ProductVariant!]
"""List of media for the product."""
media: [ProductMedia!]
"""List of images for the product."""
images: [ProductImage!] @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `media` field instead.")
"""
List of collections for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
collections: [Collection!]
"""Returns translated product fields for the given language code."""
translation(
"""A language code to return the translation for product."""
languageCode: LanguageCodeEnum!
): ProductTranslation
"""Date when product is available for purchase."""
availableForPurchase: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date.")
"""Date when product is available for purchase."""
availableForPurchaseAt: DateTime
"""Whether the product is available for purchase."""
isAvailableForPurchase: Boolean
"""
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.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
taxClass: TaxClass
}
"""
Assign attributes to a given product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductAttributeAssign {
"""The updated product type."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
input ProductAttributeAssignInput {
"""The ID of the attribute to assign."""
id: ID!
"""The attribute type to be assigned as."""
type: ProductAttributeType!
"""
Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric'].
Added in Saleor 3.1.
"""
variantSelection: Boolean
}
"""
Update attributes assigned to product variant for given product type.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductAttributeAssignmentUpdate {
"""The updated product type."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
input ProductAttributeAssignmentUpdateInput {
"""The ID of the attribute to assign."""
id: ID!
"""
Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric'].
Added in Saleor 3.1.
"""
variantSelection: Boolean!
}
enum ProductAttributeType {
PRODUCT
VARIANT
}
"""
Un-assign attributes from a given product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductAttributeUnassign {
"""The updated product type."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""
Deletes products.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""Represents product channel listing."""
type ProductChannelListing implements Node {
id: ID!
publicationDate: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date.")
"""
The product publication date time.
Added in Saleor 3.3.
"""
publishedAt: DateTime
isPublished: Boolean!
channel: Channel!
visibleInListings: Boolean!
availableForPurchase: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date.")
"""
The product available for purchase date time.
Added in Saleor 3.3.
"""
availableForPurchaseAt: DateTime
"""The price of the cheapest variant (including discounts)."""
discountedPrice: Money
"""
Purchase cost of product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
purchaseCost: MoneyRange
"""
Range of margin percentage value.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
margin: Margin
"""Whether the product is available for purchase."""
isAvailableForPurchase: Boolean
"""
Lists the storefront product's pricing, the current price and discounts, only meant for displaying.
"""
pricing(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): ProductPricingInfo
}
input ProductChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
"""Determines if object is visible to customers."""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.
"""
publicationDate: Date
"""
Publication date time. ISO 8601 standard.
Added in Saleor 3.3.
"""
publishedAt: DateTime
"""
Determines if product is visible in product listings (doesn't apply to product collections).
"""
visibleInListings: Boolean
"""Determine if product should be available for purchase."""
isAvailableForPurchase: Boolean
"""
A start date from which a product will be available for purchase. When not set and isAvailable is set to True, the current day is assumed.
DEPRECATED: this field will be removed in Saleor 4.0. Use `availableForPurchaseAt` field instead.
"""
availableForPurchaseDate: Date
"""
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.
Added in Saleor 3.3.
"""
availableForPurchaseAt: DateTime
"""List of variants to which the channel should be assigned."""
addVariants: [ID!]
"""List of variants from which the channel should be unassigned."""
removeVariants: [ID!]
}
type ProductChannelListingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ProductErrorCode!
"""List of attributes IDs which causes the error."""
attributes: [ID!]
"""List of attribute values IDs which causes the error."""
values: [ID!]
"""List of channels IDs which causes the error."""
channels: [ID!]
"""List of variants IDs which causes the error."""
variants: [ID!]
}
"""
Manage product's availability in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductChannelListingUpdate {
"""An updated product instance."""
product: Product
productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductChannelListingError!]!
}
input ProductChannelListingUpdateInput {
"""List of channels to which the product should be assigned or updated."""
updateChannels: [ProductChannelListingAddInput!]
"""List of channels from which the product should be unassigned."""
removeChannels: [ID!]
}
type ProductCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [ProductCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type ProductCountableEdge {
"""The item at the end of the edge."""
node: Product!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductCreate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
product: Product
}
input ProductCreateInput {
"""List of attributes."""
attributes: [AttributeValueInput!]
"""ID of the product's category."""
category: ID
"""
Determine if taxes are being charged for the product.
DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
"""
chargeTaxes: Boolean
"""List of IDs of collections that the product belongs to."""
collections: [ID!]
"""
Product description.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Product name."""
name: String
"""Product slug."""
slug: String
"""
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.
"""
taxClass: ID
"""
Tax rate for enabled tax gateway.
DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product.
"""
taxCode: String
"""Search engine optimization fields."""
seo: SeoInput
"""Weight of the Product."""
weight: WeightScalar
"""Defines the product rating value."""
rating: Float
"""
Fields required to update the product metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the product private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
"""ID of the type that product belongs to."""
productType: ID!
}
"""
Event sent when new product is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product the event relates to."""
product(
"""Slug of a channel for which the data should be returned."""
channel: String
): Product
"""The category of the product."""
category: Category
}
"""
Event sent when new product is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product the event relates to."""
product(
"""Slug of a channel for which the data should be returned."""
channel: String
): Product
"""The category of the product."""
category: Category
}
"""
Deletes a product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductDelete {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
product: Product
}
"""
Event sent when product is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product the event relates to."""
product(
"""Slug of a channel for which the data should be returned."""
channel: String
): Product
"""The category of the product."""
category: Category
}
type ProductError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ProductErrorCode!
"""List of attributes IDs which causes the error."""
attributes: [ID!]
"""List of attribute values IDs which causes the error."""
values: [ID!]
}
"""An enumeration."""
enum ProductErrorCode {
ALREADY_EXISTS
ATTRIBUTE_ALREADY_ASSIGNED
ATTRIBUTE_CANNOT_BE_ASSIGNED
ATTRIBUTE_VARIANTS_DISABLED
MEDIA_ALREADY_ASSIGNED
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
PRODUCT_WITHOUT_CATEGORY
NOT_PRODUCTS_IMAGE
NOT_PRODUCTS_VARIANT
NOT_FOUND
REQUIRED
UNIQUE
VARIANT_NO_DIGITAL_CONTENT
CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT
PRODUCT_NOT_ASSIGNED_TO_CHANNEL
UNSUPPORTED_MEDIA_PROVIDER
PREORDER_VARIANT_CANNOT_BE_DEACTIVATED
}
enum ProductFieldEnum {
NAME
DESCRIPTION
PRODUCT_TYPE
CATEGORY
PRODUCT_WEIGHT
COLLECTIONS
CHARGE_TAXES
PRODUCT_MEDIA
VARIANT_ID
VARIANT_SKU
VARIANT_WEIGHT
VARIANT_MEDIA
}
input ProductFilterInput {
isPublished: Boolean
collections: [ID!]
categories: [ID!]
hasCategory: Boolean
attributes: [AttributeInput!]
"""Filter by variants having specific stock status."""
stockAvailability: StockAvailability
stocks: ProductStockFilterInput
search: String
metadata: [MetadataFilter!]
"""
Filter by the publication date.
Added in Saleor 3.8.
"""
publishedFrom: DateTime
"""
Filter by availability for purchase.
Added in Saleor 3.8.
"""
isAvailable: Boolean
"""
Filter by the date of availability for purchase.
Added in Saleor 3.8.
"""
availableFrom: DateTime
"""
Filter by visibility in product listings.
Added in Saleor 3.8.
"""
isVisibleInListing: Boolean
price: PriceRangeInput
"""Filter by the lowest variant price after discounts."""
minimalPrice: PriceRangeInput
"""Filter by when was the most recent update."""
updatedAt: DateTimeRangeInput
productTypes: [ID!]
"""Filter on whether product is a gift card or not."""
giftCard: Boolean
ids: [ID!]
hasPreorderedVariants: Boolean
slugs: [String!]
"""
Specifies the channel by which the data should be filtered.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
}
"""Represents a product image."""
type ProductImage {
"""The ID of the image."""
id: ID!
"""The alt text of the image."""
alt: String
"""
The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
"""
sortOrder: Int
url(
"""
Size of the image. If not provided, the original image will be returned.
"""
size: Int
"""
The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
format: ThumbnailFormatEnum
): String!
}
input ProductInput {
"""List of attributes."""
attributes: [AttributeValueInput!]
"""ID of the product's category."""
category: ID
"""
Determine if taxes are being charged for the product.
DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
"""
chargeTaxes: Boolean
"""List of IDs of collections that the product belongs to."""
collections: [ID!]
"""
Product description.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Product name."""
name: String
"""Product slug."""
slug: String
"""
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.
"""
taxClass: ID
"""
Tax rate for enabled tax gateway.
DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product.
"""
taxCode: String
"""Search engine optimization fields."""
seo: SeoInput
"""Weight of the Product."""
weight: WeightScalar
"""Defines the product rating value."""
rating: Float
"""
Fields required to update the product metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the product private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
}
"""Represents a product media."""
type ProductMedia implements Node {
id: ID!
sortOrder: Int
alt: String!
type: ProductMediaType!
oembedData: JSONString!
url(
"""
Size of the image. If not provided, the original image will be returned.
"""
size: Int
"""
The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
format: ThumbnailFormatEnum
): String!
}
"""
Deletes product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductMediaBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""
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
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductMediaCreate {
product: Product
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
input ProductMediaCreateInput {
"""Alt text for a product media."""
alt: String
"""Represents an image file in a multipart request."""
image: Upload
"""ID of an product."""
product: ID!
"""Represents an URL to an external media."""
mediaUrl: String
}
"""
Deletes a product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductMediaDelete {
product: Product
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""
Changes ordering of the product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductMediaReorder {
product: Product
media: [ProductMedia!]
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""An enumeration."""
enum ProductMediaType {
IMAGE
VIDEO
}
"""
Updates a product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductMediaUpdate {
product: Product
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
input ProductMediaUpdateInput {
"""Alt text for a product media."""
alt: String
}
"""
Event sent when product metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product the event relates to."""
product(
"""Slug of a channel for which the data should be returned."""
channel: String
): Product
"""The category of the product."""
category: Category
}
input ProductOrder {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
"""
Sort product by the selected attribute's values.
Note: this doesn't take translations into account yet.
"""
attributeId: ID
"""Sort products by the selected field."""
field: ProductOrderField
}
enum ProductOrderField {
"""Sort products by name."""
NAME
"""
Sort products by rank. Note: This option is available only with the `search` filter.
"""
RANK
"""
Sort products by price.
This option requires a channel filter to work as the values can vary between channels.
"""
PRICE
"""
Sort products by a minimal price of a product's variant.
This option requires a channel filter to work as the values can vary between channels.
"""
MINIMAL_PRICE
"""Sort products by update date."""
LAST_MODIFIED
"""Sort products by update date."""
DATE
"""Sort products by type."""
TYPE
"""
Sort products by publication status.
This option requires a channel filter to work as the values can vary between channels.
"""
PUBLISHED
"""
Sort products by publication date.
This option requires a channel filter to work as the values can vary between channels.
"""
PUBLICATION_DATE
"""
Sort products by publication date.
This option requires a channel filter to work as the values can vary between channels.
"""
PUBLISHED_AT
"""Sort products by update date."""
LAST_MODIFIED_AT
"""
Sort products by collection. Note: This option is available only for the `Collection.products` query.
This option requires a channel filter to work as the values can vary between channels.
"""
COLLECTION
"""Sort products by rating."""
RATING
"""
Sort products by creation date.
Added in Saleor 3.8.
"""
CREATED_AT
}
"""Represents availability of a product in the storefront."""
type ProductPricingInfo {
"""Whether it is in sale or not."""
onSale: Boolean
"""The discount amount if in sale (null otherwise)."""
discount: TaxedMoney
"""The discount amount in the local currency."""
discountLocalCurrency: TaxedMoney
"""The discounted price range of the product variants."""
priceRange: TaxedMoneyRange
"""The undiscounted price range of the product variants."""
priceRangeUndiscounted: TaxedMoneyRange
"""
The discounted price range of the product variants in the local currency.
"""
priceRangeLocalCurrency: TaxedMoneyRange
"""
Determines whether this product's price displayed in a storefront should include taxes.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
displayGrossPrices: Boolean!
}
"""
Reorder product attribute values.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductReorderAttributeValues {
"""Product from which attribute values are reordered."""
product: Product
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
input ProductStockFilterInput {
warehouseIds: [ID!]
quantity: IntRangeInput
}
type ProductTranslatableContent implements Node {
id: ID!
seoTitle: String
seoDescription: String
name: String!
"""
Description of the product.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""
Description of the product.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
"""Returns translated product fields for the given language code."""
translation(
"""A language code to return the translation for product."""
languageCode: LanguageCodeEnum!
): ProductTranslation
"""Represents an individual item for sale in the storefront."""
product: Product @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
"""List of product attribute values that can be translated."""
attributeValues: [AttributeValueTranslatableContent!]!
}
"""
Creates/updates translations for a product.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type ProductTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
product: Product
}
type ProductTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
seoTitle: String
seoDescription: String
name: String
"""
Translated description of the product.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""
Translated description of the product.
Rich text format. For reference see https://editorjs.io/
"""
descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.")
}
"""
Represents a type of product. It defines what attributes are available to products of this type.
"""
type ProductType implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
slug: String!
hasVariants: Boolean!
isShippingRequired: Boolean!
isDigital: Boolean!
weight: Weight
"""The product type kind."""
kind: ProductTypeKindEnum!
"""List of products of this type."""
products(
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductCountableConnection @deprecated(reason: "This field will be removed in Saleor 4.0. Use the top-level `products` query with the `productTypes` filter.")
"""A type of tax. Assigned by enabled tax gateway"""
taxType: TaxType @deprecated(reason: "This field will be removed in Saleor 4.0. Use `taxClass` field instead.")
"""
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.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
taxClass: TaxClass
"""
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.
Requires one of the following permissions: MANAGE_TAXES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
taxClass: TaxClass
"""Variant attributes of that product type."""
variantAttributes(
"""Define scope of returned attributes."""
variantSelection: VariantAttributeScope
): [Attribute!] @deprecated(reason: "This field will be removed in Saleor 4.0. Use `assignedVariantAttributes` instead.")
"""
Variant attributes of that product type with attached variant selection.
Added in Saleor 3.1.
"""
assignedVariantAttributes(
"""Define scope of returned attributes."""
variantSelection: VariantAttributeScope
): [AssignedVariantAttribute!]
"""Product attributes of that product type."""
productAttributes: [Attribute!]
"""
List of attributes which can be assigned to this product type.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
availableAttributes(
filter: AttributeFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): AttributeCountableConnection
}
"""
Deletes product types.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductTypeBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
enum ProductTypeConfigurable {
CONFIGURABLE
SIMPLE
}
type ProductTypeCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [ProductTypeCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type ProductTypeCountableEdge {
"""The item at the end of the edge."""
node: ProductType!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductTypeCreate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
productType: ProductType
}
"""
Deletes a product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductTypeDelete {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
productType: ProductType
}
enum ProductTypeEnum {
DIGITAL
SHIPPABLE
}
input ProductTypeFilterInput {
search: String
configurable: ProductTypeConfigurable
productType: ProductTypeEnum
metadata: [MetadataFilter!]
kind: ProductTypeKindEnum
ids: [ID!]
slugs: [String!]
}
input ProductTypeInput {
"""Name of the product type."""
name: String
"""Product type slug."""
slug: String
"""The product type kind."""
kind: ProductTypeKindEnum
"""
Determines if product of this type has multiple variants. This option mainly simplifies product management in the dashboard. There is always at least one variant created under the hood.
"""
hasVariants: Boolean
"""List of attributes shared among all product variants."""
productAttributes: [ID!]
"""
List of attributes used to distinguish between different variants of a product.
"""
variantAttributes: [ID!]
"""Determines if shipping is required for products of this variant."""
isShippingRequired: Boolean
"""Determines if products are digital."""
isDigital: Boolean
"""Weight of the ProductType items."""
weight: WeightScalar
"""
Tax rate for enabled tax gateway.
DEPRECATED: this field will be removed in Saleor 4.0.. Use tax classes to control the tax calculation for a product type.
"""
taxCode: String
"""
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.
"""
taxClass: ID
}
"""An enumeration."""
enum ProductTypeKindEnum {
NORMAL
GIFT_CARD
}
"""
Reorder the attributes of a product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductTypeReorderAttributes {
"""Product type from which attributes are reordered."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
enum ProductTypeSortField {
"""Sort products by name."""
NAME
"""Sort products by type."""
DIGITAL
"""Sort products by shipping."""
SHIPPING_REQUIRED
}
input ProductTypeSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort product types by the selected field."""
field: ProductTypeSortField!
}
"""
Updates an existing product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
type ProductTypeUpdate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
productType: ProductType
}
"""
Updates an existing product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductUpdate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
product: Product
}
"""
Event sent when product is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product the event relates to."""
product(
"""Slug of a channel for which the data should be returned."""
channel: String
): Product
"""The category of the product."""
category: Category
}
"""Represents a version of a product such as different size or color."""
type ProductVariant implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
sku: String
product: Product!
trackInventory: Boolean!
quantityLimitPerCustomer: Int
weight: Weight
"""
Channel given to retrieve this product variant. Also used by federation gateway to resolve this object in a federated query.
"""
channel: String
"""
List of price information in channels for the product.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
channelListings: [ProductVariantChannelListing!]
"""
Lists the storefront variant's pricing, the current price and discounts, only meant for displaying.
"""
pricing(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
): VariantPricingInfo
"""List of attributes assigned to this variant."""
attributes(
"""Define scope of returned attributes."""
variantSelection: VariantAttributeScope
): [SelectedAttribute!]!
"""Gross margin percentage value."""
margin: Int
"""
Total quantity ordered.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
quantityOrdered: Int
"""
Total revenue generated by a variant in given period of time. Note: this field should be queried using `reportProductSales` query as it uses optimizations suitable for such calculations.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
revenue(period: ReportingPeriod): TaxedMoney
"""List of images for the product variant."""
images: [ProductImage!] @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `media` field instead.")
"""List of media for the product variant."""
media: [ProductMedia!]
"""Returns translated product variant fields for the given language code."""
translation(
"""A language code to return the translation for product variant."""
languageCode: LanguageCodeEnum!
): ProductVariantTranslation
"""
Digital content for the product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
digitalContent: DigitalContent
"""
Stocks for the product variant.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
stocks(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
"""
Two-letter ISO 3166-1 country code.
DEPRECATED: this field will be removed in Saleor 4.0. Use `address` argument instead.
"""
countryCode: CountryCode
): [Stock!]
"""
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.
"""
quantityAvailable(
"""
Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration.
"""
address: AddressInput
"""
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.
DEPRECATED: this field will be removed in Saleor 4.0. Use `address` argument instead.
"""
countryCode: CountryCode
): Int
"""
Preorder data for product variant.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
preorder: PreorderData
created: DateTime!
updatedAt: DateTime!
}
"""
Event sent when product variant is back in stock.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductVariantBackInStock implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product variant the event relates to."""
productVariant(
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
"""Look up a warehouse."""
warehouse: Warehouse
}
"""
Creates product variants for a given product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantBulkCreate {
"""Returns how many objects were created."""
count: Int!
"""List of the created variants."""
productVariants: [ProductVariant!]!
bulkProductErrors: [BulkProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [BulkProductError!]!
}
input ProductVariantBulkCreateInput {
"""List of attributes specific to this variant."""
attributes: [BulkAttributeValueInput!]!
"""Stock keeping unit."""
sku: String
"""Variant name."""
name: String
"""
Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.
"""
trackInventory: Boolean
"""Weight of the Product Variant."""
weight: WeightScalar
"""
Determines if variant is in preorder.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
preorder: PreorderSettingsInput
"""
Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
quantityLimitPerCustomer: Int
"""
Fields required to update the product variant metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the product variant private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
"""Stocks of a product available for sale."""
stocks: [StockInput!]
"""List of prices assigned to channels."""
channelListings: [ProductVariantChannelListingAddInput!]
}
"""
Deletes product variants.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""Represents product varaint channel listing."""
type ProductVariantChannelListing implements Node {
id: ID!
channel: Channel!
price: Money
"""Cost price of the variant."""
costPrice: Money
"""
Gross margin percentage value.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
margin: Int
"""
Preorder variant data.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
preorderThreshold: PreorderThreshold
}
input ProductVariantChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
"""Price of the particular variant in channel."""
price: PositiveDecimal!
"""Cost price of the variant in channel."""
costPrice: PositiveDecimal
"""
The threshold for preorder variant in channel.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
preorderThreshold: Int
}
"""
Manage product variant prices in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantChannelListingUpdate {
"""An updated product variant instance."""
variant: ProductVariant
productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductChannelListingError!]!
}
type ProductVariantCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [ProductVariantCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type ProductVariantCountableEdge {
"""The item at the end of the edge."""
node: ProductVariant!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new variant for a product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantCreate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
productVariant: ProductVariant
}
input ProductVariantCreateInput {
"""List of attributes specific to this variant."""
attributes: [AttributeValueInput!]!
"""Stock keeping unit."""
sku: String
"""Variant name."""
name: String
"""
Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.
"""
trackInventory: Boolean
"""Weight of the Product Variant."""
weight: WeightScalar
"""
Determines if variant is in preorder.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
preorder: PreorderSettingsInput
"""
Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
quantityLimitPerCustomer: Int
"""
Fields required to update the product variant metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the product variant private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
"""Product ID of which type is the variant."""
product: ID!
"""Stocks of a product available for sale."""
stocks: [StockInput!]
}
"""
Event sent when new product variant is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductVariantCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product variant the event relates to."""
productVariant(
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
}
"""
Event sent when new product variant is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductVariantCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product variant the event relates to."""
productVariant(
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
}
"""
Deletes a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantDelete {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
productVariant: ProductVariant
}
"""
Event sent when product variant is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductVariantDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product variant the event relates to."""
productVariant(
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
}
input ProductVariantFilterInput {
search: String
sku: [String!]
metadata: [MetadataFilter!]
isPreorder: Boolean
updatedAt: DateTimeRangeInput
}
input ProductVariantInput {
"""List of attributes specific to this variant."""
attributes: [AttributeValueInput!]
"""Stock keeping unit."""
sku: String
"""Variant name."""
name: String
"""
Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item.
"""
trackInventory: Boolean
"""Weight of the Product Variant."""
weight: WeightScalar
"""
Determines if variant is in preorder.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
preorder: PreorderSettingsInput
"""
Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
quantityLimitPerCustomer: Int
"""
Fields required to update the product variant metadata.
Added in Saleor 3.8.
"""
metadata: [MetadataInput!]
"""
Fields required to update the product variant private metadata.
Added in Saleor 3.8.
"""
privateMetadata: [MetadataInput!]
}
"""
Event sent when product variant metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductVariantMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product variant the event relates to."""
productVariant(
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
}
"""
Event sent when product variant is out of stock.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductVariantOutOfStock implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product variant the event relates to."""
productVariant(
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
"""Look up a warehouse."""
warehouse: Warehouse
}
"""
Deactivates product variant preorder. It changes all preorder allocation into regular allocation.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantPreorderDeactivate {
"""Product variant with ended preorder."""
productVariant: ProductVariant
errors: [ProductError!]!
}
"""
Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantReorder {
product: Product
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""
Reorder product variant attribute values.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantReorderAttributeValues {
"""Product variant from which attribute values are reordered."""
productVariant: ProductVariant
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""
Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantSetDefault {
product: Product
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
enum ProductVariantSortField {
"""Sort products variants by last modified at."""
LAST_MODIFIED_AT
}
input ProductVariantSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort productVariants by the selected field."""
field: ProductVariantSortField!
}
"""
Creates stocks for product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantStocksCreate {
"""Updated product variant."""
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [BulkStockError!]!
}
"""
Delete stocks from product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantStocksDelete {
"""Updated product variant."""
productVariant: ProductVariant
stockErrors: [StockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [StockError!]!
}
"""
Update stocks for product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantStocksUpdate {
"""Updated product variant."""
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [BulkStockError!]!
}
type ProductVariantTranslatableContent implements Node {
id: ID!
name: String!
"""Returns translated product variant fields for the given language code."""
translation(
"""A language code to return the translation for product variant."""
languageCode: LanguageCodeEnum!
): ProductVariantTranslation
"""Represents a version of a product such as different size or color."""
productVariant: ProductVariant @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
"""List of product variant attribute values that can be translated."""
attributeValues: [AttributeValueTranslatableContent!]!
}
"""
Creates/updates translations for a product variant.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type ProductVariantTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
productVariant: ProductVariant
}
type ProductVariantTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
name: String!
}
"""
Updates an existing variant for product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type ProductVariantUpdate {
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
productVariant: ProductVariant
}
"""
Event sent when product variant is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ProductVariantUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The product variant the event relates to."""
productVariant(
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
}
input PublishableChannelListingInput {
"""ID of a channel."""
channelId: ID!
"""Determines if object is visible to customers."""
isPublished: Boolean
"""
Publication date. ISO 8601 standard.
DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead.
"""
publicationDate: Date
"""
Publication date time. ISO 8601 standard.
Added in Saleor 3.3.
"""
publishedAt: DateTime
}
type Query {
"""
Look up a webhook by ID. Requires one of the following permissions: MANAGE_APPS, OWNER.
"""
webhook(
"""ID of the webhook."""
id: ID!
): Webhook
"""
List of all available webhook events.
Requires one of the following permissions: MANAGE_APPS.
"""
webhookEvents: [WebhookEvent!] @deprecated(reason: "This field will be removed in Saleor 4.0. Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types.")
"""
Retrieve a sample payload for a given webhook event based on real data. It can be useful for some integrations where sample payload is required.
"""
webhookSamplePayload(
"""Name of the requested event type."""
eventType: WebhookSampleEventTypeEnum!
): JSONString
"""
Look up a warehouse by ID.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS, MANAGE_SHIPPING.
"""
warehouse(
"""ID of an warehouse"""
id: ID!
): Warehouse
"""
List of warehouses.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS, MANAGE_SHIPPING.
"""
warehouses(
filter: WarehouseFilterInput
sortBy: WarehouseSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): WarehouseCountableConnection
"""
Returns a list of all translatable items of a given kind.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
translations(
"""Kind of objects to retrieve."""
kind: TranslatableKinds!
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): TranslatableItemConnection
"""
Lookup a translatable item by ID.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
translation(
"""ID of the object to retrieve."""
id: ID!
"""Kind of the object to retrieve."""
kind: TranslatableKinds!
): TranslatableItem
"""
Look up a tax configuration.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
taxConfiguration(
"""ID of a tax configuration."""
id: ID!
): TaxConfiguration
"""
List of tax configurations.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
taxConfigurations(
"""Filtering options for tax configurations."""
filter: TaxConfigurationFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): TaxConfigurationCountableConnection
"""
Look up a tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
taxClass(
"""ID of a tax class."""
id: ID!
): TaxClass
"""
List of tax classes.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
taxClasses(
"""Sort tax classes."""
sortBy: TaxClassSortingInput
"""Filtering options for tax classes."""
filter: TaxClassFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): TaxClassCountableConnection
"""
Tax class rates grouped by country.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
taxCountryConfiguration(
"""Country for which to return tax class rates."""
countryCode: CountryCode!
): TaxCountryConfiguration
"""
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
taxCountryConfigurations: [TaxCountryConfiguration!]
"""
Look up a stock by ID
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
stock(
"""ID of an warehouse"""
id: ID!
): Stock
"""
List of stocks.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
stocks(
filter: StockFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): StockCountableConnection
"""Return information about the shop."""
shop: Shop!
"""
Order related settings from site settings.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orderSettings: OrderSettings
"""
Gift card related settings from site settings.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardSettings: GiftCardSettings!
"""
Look up a shipping zone by ID.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingZone(
"""ID of the shipping zone."""
id: ID!
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
"""
List of the shop's shipping zones.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingZones(
"""Filtering options for shipping zones."""
filter: ShippingZoneFilterInput
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ShippingZoneCountableConnection
"""
Look up digital content by ID.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
digitalContent(
"""ID of the digital content."""
id: ID!
): DigitalContent
"""
List of digital content.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
digitalContents(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): DigitalContentCountableConnection
"""List of the shop's categories."""
categories(
"""Filtering options for categories."""
filter: CategoryFilterInput
"""Sort categories."""
sortBy: CategorySortingInput
"""Filter categories by the nesting level in the category tree."""
level: Int
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CategoryCountableConnection
"""Look up a category by ID or slug."""
category(
"""ID of the category."""
id: ID
"""Slug of the category"""
slug: String
): Category
"""
Look up a collection by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
collection(
"""ID of the collection."""
id: ID
"""Slug of the category"""
slug: String
"""Slug of a channel for which the data should be returned."""
channel: String
): Collection
"""
List of the shop's collections. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
collections(
"""Filtering options for collections."""
filter: CollectionFilterInput
"""Sort collections."""
sortBy: CollectionSortingInput
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CollectionCountableConnection
"""
Look up a product by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
product(
"""ID of the product."""
id: ID
"""Slug of the product."""
slug: String
"""Slug of a channel for which the data should be returned."""
channel: String
): Product
"""
List of the shop's products. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
products(
"""Filtering options for products."""
filter: ProductFilterInput
"""Sort products."""
sortBy: ProductOrder
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductCountableConnection
"""Look up a product type by ID."""
productType(
"""ID of the product type."""
id: ID!
): ProductType
"""List of the shop's product types."""
productTypes(
"""Filtering options for product types."""
filter: ProductTypeFilterInput
"""Sort product types."""
sortBy: ProductTypeSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductTypeCountableConnection
"""
Look up a product variant by ID or SKU. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
productVariant(
"""ID of the product variant."""
id: ID
"""Sku of the product variant."""
sku: String
"""Slug of a channel for which the data should be returned."""
channel: String
): ProductVariant
"""
List of product variants. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
productVariants(
"""Filter product variants by given IDs."""
ids: [ID!]
"""Slug of a channel for which the data should be returned."""
channel: String
"""Filtering options for product variant."""
filter: ProductVariantFilterInput
"""Sort products variants."""
sortBy: ProductVariantSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductVariantCountableConnection
"""
List of top selling products.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
reportProductSales(
"""Span of time."""
period: ReportingPeriod!
"""Slug of a channel for which the data should be returned."""
channel: String!
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductVariantCountableConnection
"""
Look up a payment by ID.
Requires one of the following permissions: MANAGE_ORDERS.
"""
payment(
"""ID of the payment."""
id: ID!
): Payment
"""
List of payments.
Requires one of the following permissions: MANAGE_ORDERS.
"""
payments(
"""Filtering options for payments."""
filter: PaymentFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): PaymentCountableConnection
"""
Look up a transaction by ID.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: HANDLE_PAYMENTS.
"""
transaction(
"""ID of a transaction."""
id: ID!
): TransactionItem
"""Look up a page by ID or slug."""
page(
"""ID of the page."""
id: ID
"""The slug of the page."""
slug: String
): Page
"""List of the shop's pages."""
pages(
"""Sort pages."""
sortBy: PageSortingInput
"""Filtering options for pages."""
filter: PageFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): PageCountableConnection
"""Look up a page type by ID."""
pageType(
"""ID of the page type."""
id: ID!
): PageType
"""List of the page types."""
pageTypes(
"""Sort page types."""
sortBy: PageTypeSortingInput
"""Filtering options for page types."""
filter: PageTypeFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): PageTypeCountableConnection
"""
List of activity events to display on homepage (at the moment it only contains order-events).
Requires one of the following permissions: MANAGE_ORDERS.
"""
homepageEvents(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): OrderEventCountableConnection
"""Look up an order by ID."""
order(
"""ID of an order."""
id: ID!
): Order
"""
List of orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
orders(
"""Sort orders."""
sortBy: OrderSortingInput
"""Filtering options for orders."""
filter: OrderFilterInput
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): OrderCountableConnection
"""
List of draft orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
draftOrders(
"""Sort draft orders."""
sortBy: OrderSortingInput
"""Filtering options for draft orders."""
filter: OrderDraftFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): OrderCountableConnection
"""
Return the total sales amount from a specific period.
Requires one of the following permissions: MANAGE_ORDERS.
"""
ordersTotal(
"""A period of time."""
period: ReportingPeriod
"""Slug of a channel for which the data should be returned."""
channel: String
): TaxedMoney
"""Look up an order by token."""
orderByToken(
"""The order's token."""
token: UUID!
): Order @deprecated(reason: "This field will be removed in Saleor 4.0.")
"""Look up a navigation menu by ID or name."""
menu(
"""Slug of a channel for which the data should be returned."""
channel: String
"""ID of the menu."""
id: ID
"""The menu's name."""
name: String
"""The menu's slug."""
slug: String
): Menu
"""List of the storefront's menus."""
menus(
"""Slug of a channel for which the data should be returned."""
channel: String
"""Sort menus."""
sortBy: MenuSortingInput
"""
Filtering options for menus.
`slug`: This field will be removed in Saleor 4.0. Use `slugs` instead.
"""
filter: MenuFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): MenuCountableConnection
"""Look up a menu item by ID."""
menuItem(
"""ID of the menu item."""
id: ID!
"""Slug of a channel for which the data should be returned."""
channel: String
): MenuItem
"""List of the storefronts's menu items."""
menuItems(
"""Slug of a channel for which the data should be returned."""
channel: String
"""Sort menus items."""
sortBy: MenuItemSortingInput
"""Filtering options for menu items."""
filter: MenuItemFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): MenuItemCountableConnection
"""
Look up a gift card by ID.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCard(
"""ID of the gift card."""
id: ID!
): GiftCard
"""
List of gift cards.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCards(
"""
Sort gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
sortBy: GiftCardSortingInput
"""
Filtering options for gift cards.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
filter: GiftCardFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): GiftCardCountableConnection
"""
List of gift card currencies.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardCurrencies: [String!]!
"""
List of gift card tags.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
giftCardTags(
"""Filtering options for gift card tags."""
filter: GiftCardTagFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): GiftCardTagCountableConnection
"""
Look up a plugin by ID.
Requires one of the following permissions: MANAGE_PLUGINS.
"""
plugin(
"""ID of the plugin."""
id: ID!
): Plugin
"""
List of plugins.
Requires one of the following permissions: MANAGE_PLUGINS.
"""
plugins(
"""Filtering options for plugins."""
filter: PluginFilterInput
"""Sort plugins."""
sortBy: PluginSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): PluginCountableConnection
"""
Look up a sale by ID.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
sale(
"""ID of the sale."""
id: ID!
"""Slug of a channel for which the data should be returned."""
channel: String
): Sale
"""
List of the shop's sales.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
sales(
"""Filtering options for sales."""
filter: SaleFilterInput
"""Sort sales."""
sortBy: SaleSortingInput
"""
Search sales by name, value or type.
DEPRECATED: this field will be removed in Saleor 4.0. Use `filter.search` input instead.
"""
query: String
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): SaleCountableConnection
"""
Look up a voucher by ID.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucher(
"""ID of the voucher."""
id: ID!
"""Slug of a channel for which the data should be returned."""
channel: String
): Voucher
"""
List of the shop's vouchers.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
vouchers(
"""Filtering options for vouchers."""
filter: VoucherFilterInput
"""Sort voucher."""
sortBy: VoucherSortingInput
"""
Search vouchers by name or code.
DEPRECATED: this field will be removed in Saleor 4.0. Use `filter.search` input instead.
"""
query: String
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): VoucherCountableConnection
"""
Look up a export file by ID.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
exportFile(
"""ID of the export file job."""
id: ID!
): ExportFile
"""
List of export files.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
exportFiles(
"""Filtering options for export files."""
filter: ExportFileFilterInput
"""Sort export files."""
sortBy: ExportFileSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ExportFileCountableConnection
"""List of all tax rates available from tax gateway."""
taxTypes: [TaxType!]
"""Look up a checkout by token and slug of channel."""
checkout(
"""
The checkout's ID.
Added in Saleor 3.4.
"""
id: ID
"""
The checkout's token.
DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead.
"""
token: UUID
): Checkout
"""
List of checkouts.
Requires one of the following permissions: MANAGE_CHECKOUTS.
"""
checkouts(
"""
Sort checkouts.
Added in Saleor 3.1.
"""
sortBy: CheckoutSortingInput
"""
Filtering options for checkouts.
Added in Saleor 3.1.
"""
filter: CheckoutFilterInput
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CheckoutCountableConnection
"""
List of checkout lines.
Requires one of the following permissions: MANAGE_CHECKOUTS.
"""
checkoutLines(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CheckoutLineCountableConnection
"""Look up a channel by ID or slug."""
channel(
"""ID of the channel."""
id: ID
"""
Slug of the channel.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
slug: String
): Channel
"""
List of all channels.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
channels: [Channel!]
"""List of the shop's attributes."""
attributes(
"""Filtering options for attributes."""
filter: AttributeFilterInput
"""Sorting options for attributes."""
sortBy: AttributeSortingInput
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): AttributeCountableConnection
"""Look up an attribute by ID."""
attribute(
"""ID of the attribute."""
id: ID
"""Slug of the attribute."""
slug: String
): Attribute
"""
List of all apps installations
Requires one of the following permissions: MANAGE_APPS.
"""
appsInstallations: [AppInstallation!]!
"""
List of the apps.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, MANAGE_APPS.
"""
apps(
"""Filtering options for apps."""
filter: AppFilterInput
"""Sort apps."""
sortBy: AppSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): AppCountableConnection
"""
Look up an app by ID. If ID is not provided, return the currently authenticated app.
Requires 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.
"""
app(
"""ID of the app."""
id: ID
): App
"""
List of all extensions.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
appExtensions(
"""Filtering options for apps extensions."""
filter: AppExtensionFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): AppExtensionCountableConnection
"""
Look up an app extension by ID.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
appExtension(
"""ID of the app extension."""
id: ID!
): AppExtension
"""Returns address validation rules."""
addressValidationRules(
"""Two-letter ISO 3166-1 country code."""
countryCode: CountryCode!
"""Designation of a region, province or state."""
countryArea: String
"""City or a town name."""
city: String
"""Sublocality like a district."""
cityArea: String
): AddressValidationData
"""Look up an address by ID."""
address(
"""ID of an address."""
id: ID!
): Address
"""
List of the shop's customers.
Requires one of the following permissions: MANAGE_ORDERS, MANAGE_USERS.
"""
customers(
"""Filtering options for customers."""
filter: CustomerFilterInput
"""Sort customers."""
sortBy: UserSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): UserCountableConnection
"""
List of permission groups.
Requires one of the following permissions: MANAGE_STAFF.
"""
permissionGroups(
"""Filtering options for permission groups."""
filter: PermissionGroupFilterInput
"""Sort permission groups."""
sortBy: PermissionGroupSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): GroupCountableConnection
"""
Look up permission group by ID.
Requires one of the following permissions: MANAGE_STAFF.
"""
permissionGroup(
"""ID of the group."""
id: ID!
): Group
"""Return the currently authenticated user."""
me: User
"""
List of the shop's staff users.
Requires one of the following permissions: MANAGE_STAFF.
"""
staffUsers(
"""Filtering options for staff users."""
filter: StaffUserInput
"""Sort staff users."""
sortBy: UserSortingInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): UserCountableConnection
"""
Look up a user by ID or email address.
Requires one of the following permissions: MANAGE_STAFF, MANAGE_USERS, MANAGE_ORDERS.
"""
user(
"""ID of the user."""
id: ID
"""Email address of the user."""
email: String
): User
_entities(representations: [_Any]): [_Entity]
_service: _Service
}
"""Represents a reduced VAT rate for a particular type of goods."""
type ReducedRate {
"""Reduced VAT rate in percent."""
rate: Float!
"""A type of goods."""
rateType: String!
}
"""
Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie.
"""
type RefreshToken {
"""JWT token, required to authenticate."""
token: String
"""A user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
input ReorderInput {
"""The ID of the item to move."""
id: ID!
"""
The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged.
"""
sortOrder: Int
}
enum ReportingPeriod {
TODAY
THIS_MONTH
}
"""
Request email change of the logged in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type RequestEmailChange {
"""A user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""Sends an email with the account password modification link."""
type RequestPasswordReset {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Sales allow creating discounts for categories, collections or products and are visible to all the customers.
"""
type Sale implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
type: SaleType!
startDate: DateTime!
endDate: DateTime
created: DateTime!
updatedAt: DateTime!
"""List of categories this sale applies to."""
categories(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CategoryCountableConnection
"""
List of collections this sale applies to.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
collections(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CollectionCountableConnection
"""
List of products this sale applies to.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
products(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductCountableConnection
"""
List of product variants this sale applies to.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
variants(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductVariantCountableConnection
"""Returns translated sale fields for the given language code."""
translation(
"""A language code to return the translation for sale."""
languageCode: LanguageCodeEnum!
): SaleTranslation
"""
List of channels available for the sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
channelListings: [SaleChannelListing!]
"""Sale value."""
discountValue: Float
"""Currency code for sale."""
currency: String
}
"""
Adds products, categories, collections to a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type SaleAddCatalogues {
"""Sale of which catalogue IDs will be modified."""
sale: Sale
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
"""
Deletes sales.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type SaleBulkDelete {
"""Returns how many objects were affected."""
count: Int!
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
"""Represents sale channel listing."""
type SaleChannelListing implements Node {
id: ID!
channel: Channel!
discountValue: Float!
currency: String!
}
input SaleChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
"""The value of the discount."""
discountValue: PositiveDecimal!
}
input SaleChannelListingInput {
"""List of channels to which the sale should be assigned."""
addChannels: [SaleChannelListingAddInput!]
"""List of channels from which the sale should be unassigned."""
removeChannels: [ID!]
}
"""
Manage sale's availability in channels.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type SaleChannelListingUpdate {
"""An updated sale instance."""
sale: Sale
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
type SaleCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [SaleCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type SaleCountableEdge {
"""The item at the end of the edge."""
node: Sale!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type SaleCreate {
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
sale: Sale
}
"""
Event sent when new sale is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type SaleCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The sale the event relates to."""
sale(
"""Slug of a channel for which the data should be returned."""
channel: String
): Sale
}
"""
Deletes a sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type SaleDelete {
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
sale: Sale
}
"""
Event sent when sale is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type SaleDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The sale the event relates to."""
sale(
"""Slug of a channel for which the data should be returned."""
channel: String
): Sale
}
input SaleFilterInput {
status: [DiscountStatusEnum!]
saleType: DiscountValueTypeEnum
started: DateTimeRangeInput
search: String
metadata: [MetadataFilter!]
updatedAt: DateTimeRangeInput
}
input SaleInput {
"""Voucher name."""
name: String
"""Fixed or percentage."""
type: DiscountValueTypeEnum
"""Value of the voucher."""
value: PositiveDecimal
"""Products related to the discount."""
products: [ID!]
variants: [ID!]
"""Categories related to the discount."""
categories: [ID!]
"""Collections related to the discount."""
collections: [ID!]
"""Start date of the voucher in ISO 8601 format."""
startDate: DateTime
"""End date of the voucher in ISO 8601 format."""
endDate: DateTime
}
"""
Removes products, categories, collections from a sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type SaleRemoveCatalogues {
"""Sale of which catalogue IDs will be modified."""
sale: Sale
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
enum SaleSortField {
"""Sort sales by name."""
NAME
"""Sort sales by start date."""
START_DATE
"""Sort sales by end date."""
END_DATE
"""
Sort sales by value.
This option requires a channel filter to work as the values can vary between channels.
"""
VALUE
"""Sort sales by type."""
TYPE
"""Sort sales by created at."""
CREATED_AT
"""Sort sales by last modified at."""
LAST_MODIFIED_AT
}
input SaleSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
"""Sort sales by the selected field."""
field: SaleSortField!
}
"""
The event informs about the start or end of the sale.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type SaleToggle implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""
The sale the event relates to.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
sale(
"""Slug of a channel for which the data should be returned."""
channel: String
): Sale
}
type SaleTranslatableContent implements Node {
id: ID!
name: String!
"""Returns translated sale fields for the given language code."""
translation(
"""A language code to return the translation for sale."""
languageCode: LanguageCodeEnum!
): SaleTranslation
"""
Sales allow creating discounts for categories, collections or products and are visible to all the customers.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
sale: Sale @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
}
"""
Creates/updates translations for a sale.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type SaleTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
sale: Sale
}
type SaleTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
name: String
}
enum SaleType {
FIXED
PERCENTAGE
}
"""
Updates a sale.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type SaleUpdate {
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
sale: Sale
}
"""
Event sent when sale is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type SaleUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The sale the event relates to."""
sale(
"""Slug of a channel for which the data should be returned."""
channel: String
): Sale
}
"""Represents a custom attribute."""
type SelectedAttribute {
"""Name of an attribute displayed in the interface."""
attribute: Attribute!
"""Values of an attribute."""
values: [AttributeValue!]!
}
input SeoInput {
"""SEO title."""
title: String
"""SEO description."""
description: String
}
"""
Sets the user's password from the token sent by email using the RequestPasswordReset mutation.
"""
type SetPassword {
"""JWT token, required to authenticate."""
token: String
"""JWT refresh token, required to re-generate access token."""
refreshToken: String
"""CSRF token required to re-generate access token."""
csrfToken: String
"""A user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
type ShippingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ShippingErrorCode!
"""List of warehouse IDs which causes the error."""
warehouses: [ID!]
"""List of channels IDs which causes the error."""
channels: [ID!]
}
"""An enumeration."""
enum ShippingErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
MAX_LESS_THAN_MIN
NOT_FOUND
REQUIRED
UNIQUE
DUPLICATED_INPUT_ITEM
}
"""
List shipping methods for checkout.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingListMethodsForCheckout implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The checkout the event relates to."""
checkout: Checkout
"""
Shipping methods that can be used with this checkout.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
shippingMethods: [ShippingMethod!]
}
"""
Shipping methods that can be used as means of shipping for orders and checkouts.
"""
type ShippingMethod implements Node & ObjectWithMetadata {
"""Unique ID of ShippingMethod available for Order."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""Type of the shipping method."""
type: ShippingMethodTypeEnum @deprecated(reason: "This field will be removed in Saleor 4.0.")
"""Shipping method name."""
name: String!
"""
Shipping method description.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Maximum delivery days for this shipping method."""
maximumDeliveryDays: Int
"""Minimum delivery days for this shipping method."""
minimumDeliveryDays: Int
"""Maximum order weight for this shipping method."""
maximumOrderWeight: Weight @deprecated(reason: "This field will be removed in Saleor 4.0.")
"""Minimum order weight for this shipping method."""
minimumOrderWeight: Weight @deprecated(reason: "This field will be removed in Saleor 4.0.")
"""Returns translated shipping method fields for the given language code."""
translation(
"""A language code to return the translation for shipping method."""
languageCode: LanguageCodeEnum!
): ShippingMethodTranslation
"""The price of selected shipping method."""
price: Money!
"""Maximum order price for this shipping method."""
maximumOrderPrice: Money
"""Minimal order price for this shipping method."""
minimumOrderPrice: Money
"""Describes if this shipping method is active and can be selected."""
active: Boolean!
"""Message connected to this shipping method."""
message: String
}
"""Represents shipping method channel listing."""
type ShippingMethodChannelListing implements Node {
id: ID!
channel: Channel!
maximumOrderPrice: Money
minimumOrderPrice: Money
price: Money
}
input ShippingMethodChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
"""Shipping price of the shipping method in this channel."""
price: PositiveDecimal
"""Minimum order price to use this shipping method."""
minimumOrderPrice: PositiveDecimal
"""Maximum order price to use this shipping method."""
maximumOrderPrice: PositiveDecimal
}
input ShippingMethodChannelListingInput {
"""List of channels to which the shipping method should be assigned."""
addChannels: [ShippingMethodChannelListingAddInput!]
"""List of channels from which the shipping method should be unassigned."""
removeChannels: [ID!]
}
"""
Manage shipping method's availability in channels.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingMethodChannelListingUpdate {
"""An updated shipping method instance."""
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
"""Represents shipping method postal code rule."""
type ShippingMethodPostalCodeRule implements Node {
"""The ID of the object."""
id: ID!
"""Start address range."""
start: String
"""End address range."""
end: String
"""Inclusion type of the postal code rule."""
inclusionType: PostalCodeRuleInclusionTypeEnum
}
type ShippingMethodTranslatableContent implements Node {
id: ID!
name: String!
"""
Description of the shipping method.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Returns translated shipping method fields for the given language code."""
translation(
"""A language code to return the translation for shipping method."""
languageCode: LanguageCodeEnum!
): ShippingMethodTranslation
"""
Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
shippingMethod: ShippingMethodType @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
}
type ShippingMethodTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
name: String
"""
Translated description of the shipping method.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
}
"""
Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.
"""
type ShippingMethodType implements Node & ObjectWithMetadata {
"""Shipping method ID."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""Shipping method name."""
name: String!
"""
Shipping method description.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
"""Type of the shipping method."""
type: ShippingMethodTypeEnum
"""Returns translated shipping method fields for the given language code."""
translation(
"""A language code to return the translation for shipping method."""
languageCode: LanguageCodeEnum!
): ShippingMethodTranslation
"""
List of channels available for the method.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
channelListings: [ShippingMethodChannelListing!]
"""The price of the cheapest variant (including discounts)."""
maximumOrderPrice: Money
"""The price of the cheapest variant (including discounts)."""
minimumOrderPrice: Money
"""
Postal code ranges rule of exclusion or inclusion of the shipping method.
"""
postalCodeRules: [ShippingMethodPostalCodeRule!]
"""
List of excluded products for the shipping method.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
excludedProducts(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductCountableConnection
"""Minimum order weight to use this shipping method."""
minimumOrderWeight: Weight
"""Maximum order weight to use this shipping method."""
maximumOrderWeight: Weight
"""Maximum number of days for delivery."""
maximumDeliveryDays: Int
"""Minimal number of days for delivery."""
minimumDeliveryDays: Int
"""
Tax class assigned to this shipping method.
Requires one of the following permissions: MANAGE_TAXES, MANAGE_SHIPPING.
"""
taxClass: TaxClass
}
"""An enumeration."""
enum ShippingMethodTypeEnum {
PRICE
WEIGHT
}
"""
List of shipping methods available for the country.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingMethodsPerCountry {
"""The country code."""
countryCode: CountryCode!
"""List of available shipping methods."""
shippingMethods: [ShippingMethod!]
}
input ShippingPostalCodeRulesCreateInputRange {
"""Start range of the postal code."""
start: String!
"""End range of the postal code."""
end: String
}
"""
Deletes shipping prices.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingPriceBulkDelete {
"""Returns how many objects were affected."""
count: Int!
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
"""
Creates a new shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingPriceCreate {
"""A shipping zone to which the shipping method belongs."""
shippingZone: ShippingZone
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
"""
Event sent when new shipping price is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingPriceCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping method the event relates to."""
shippingMethod(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingMethodType
"""The shipping zone the shipping method belongs to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Deletes a shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingPriceDelete {
"""A shipping method to delete."""
shippingMethod: ShippingMethodType
"""A shipping zone to which the shipping method belongs."""
shippingZone: ShippingZone
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
"""
Event sent when shipping price is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingPriceDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping method the event relates to."""
shippingMethod(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingMethodType
"""The shipping zone the shipping method belongs to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Exclude products from shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingPriceExcludeProducts {
"""A shipping method with new list of excluded products."""
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
input ShippingPriceExcludeProductsInput {
"""List of products which will be excluded."""
products: [ID!]!
}
input ShippingPriceInput {
"""Name of the shipping method."""
name: String
"""Shipping method description."""
description: JSONString
"""Minimum order weight to use this shipping method."""
minimumOrderWeight: WeightScalar
"""Maximum order weight to use this shipping method."""
maximumOrderWeight: WeightScalar
"""Maximum number of days for delivery."""
maximumDeliveryDays: Int
"""Minimal number of days for delivery."""
minimumDeliveryDays: Int
"""Shipping type: price or weight based."""
type: ShippingMethodTypeEnum
"""Shipping zone this method belongs to."""
shippingZone: ID
"""Postal code rules to add."""
addPostalCodeRules: [ShippingPostalCodeRulesCreateInputRange!]
"""Postal code rules to delete."""
deletePostalCodeRules: [ID!]
"""Inclusion type for currently assigned postal code rules."""
inclusionType: PostalCodeRuleInclusionTypeEnum
"""
ID of a tax class to assign to this shipping method. If not provided, the default tax class will be used.
"""
taxClass: ID
}
"""
Remove product from excluded list for shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingPriceRemoveProductFromExclude {
"""A shipping method with new list of excluded products."""
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
"""
Creates/updates translations for a shipping method.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type ShippingPriceTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
shippingMethod: ShippingMethodType
}
input ShippingPriceTranslationInput {
name: String
"""
Translated shipping method description.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
}
"""
Updates a new shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingPriceUpdate {
"""A shipping zone to which the shipping method belongs."""
shippingZone: ShippingZone
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
"""
Event sent when shipping price is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingPriceUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping method the event relates to."""
shippingMethod(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingMethodType
"""The shipping zone the shipping method belongs to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly.
"""
type ShippingZone implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
default: Boolean!
"""Lowest and highest prices for the shipping."""
priceRange: MoneyRange
"""List of countries available for the method."""
countries: [CountryDisplay!]!
"""
List of shipping methods available for orders shipped to countries within this shipping zone.
"""
shippingMethods: [ShippingMethodType!]
"""List of warehouses for shipping zone."""
warehouses: [Warehouse!]!
"""List of channels for shipping zone."""
channels: [Channel!]!
"""Description of a shipping zone."""
description: String
}
"""
Deletes shipping zones.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingZoneBulkDelete {
"""Returns how many objects were affected."""
count: Int!
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
}
type ShippingZoneCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [ShippingZoneCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type ShippingZoneCountableEdge {
"""The item at the end of the edge."""
node: ShippingZone!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingZoneCreate {
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
shippingZone: ShippingZone
}
input ShippingZoneCreateInput {
"""Shipping zone's name. Visible only to the staff."""
name: String
"""Description of the shipping zone."""
description: String
"""List of countries in this shipping zone."""
countries: [String!]
"""
Default shipping zone will be used for countries not covered by other zones.
"""
default: Boolean
"""List of warehouses to assign to a shipping zone"""
addWarehouses: [ID!]
"""List of channels to assign to the shipping zone."""
addChannels: [ID!]
}
"""
Event sent when new shipping zone is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingZoneCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping zone the event relates to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Event sent when new shipping zone is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingZoneCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping zone the event relates to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Deletes a shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingZoneDelete {
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
shippingZone: ShippingZone
}
"""
Event sent when shipping zone is deleted.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingZoneDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping zone the event relates to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
input ShippingZoneFilterInput {
search: String
channels: [ID!]
}
"""
Event sent when shipping zone metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingZoneMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping zone the event relates to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Updates a new shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
type ShippingZoneUpdate {
shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShippingError!]!
shippingZone: ShippingZone
}
input ShippingZoneUpdateInput {
"""Shipping zone's name. Visible only to the staff."""
name: String
"""Description of the shipping zone."""
description: String
"""List of countries in this shipping zone."""
countries: [String!]
"""
Default shipping zone will be used for countries not covered by other zones.
"""
default: Boolean
"""List of warehouses to assign to a shipping zone"""
addWarehouses: [ID!]
"""List of channels to assign to the shipping zone."""
addChannels: [ID!]
"""List of warehouses to unassign from a shipping zone"""
removeWarehouses: [ID!]
"""List of channels to unassign from the shipping zone."""
removeChannels: [ID!]
}
"""
Event sent when shipping zone is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingZoneUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping zone the event relates to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Event sent when shipping zone is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type ShippingZoneUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The shipping zone the event relates to."""
shippingZone(
"""Slug of a channel for which the data should be returned."""
channel: String
): ShippingZone
}
"""
Represents a shop resource containing general shop data and configuration.
"""
type Shop {
"""List of available payment gateways."""
availablePaymentGateways(
"""
A currency for which gateways will be returned.
DEPRECATED: this field will be removed in Saleor 4.0. Use `channel` argument instead.
"""
currency: String
"""Slug of a channel for which the data should be returned."""
channel: String
): [PaymentGateway!]!
"""List of available external authentications."""
availableExternalAuthentications: [ExternalAuthentication!]!
"""Shipping methods that are available for the shop."""
availableShippingMethods(
"""Slug of a channel for which the data should be returned."""
channel: String!
"""Address for which available shipping methods should be returned."""
address: AddressInput
): [ShippingMethod!]
"""
List of all currencies supported by shop's channels.
Added in Saleor 3.1.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
channelCurrencies: [String!]!
"""List of countries available in the shop."""
countries(
"""
A language code to return the translation for.
DEPRECATED: this field will be removed in Saleor 4.0.
"""
languageCode: LanguageCodeEnum
"""Filtering options for countries"""
filter: CountryFilterInput
): [CountryDisplay!]!
"""Shop's default country."""
defaultCountry: CountryDisplay
"""
Default shop's email sender's name.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
defaultMailSenderName: String
"""
Default shop's email sender's address.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
defaultMailSenderAddress: String
"""Shop's description."""
description: String
"""Shop's domain data."""
domain: Domain!
"""List of the shops's supported languages."""
languages: [LanguageDisplay!]!
"""Shop's name."""
name: String!
"""List of available permissions."""
permissions: [Permission!]!
"""List of possible phone prefixes."""
phonePrefixes: [String!]!
"""Header text."""
headerText: String
"""
Automatically approve all new fulfillments.
Added in Saleor 3.1.
"""
fulfillmentAutoApprove: Boolean!
"""
Allow to approve fulfillments which are unpaid.
Added in Saleor 3.1.
"""
fulfillmentAllowUnpaid: Boolean!
"""Enable inventory tracking."""
trackInventoryByDefault: Boolean
"""Default weight unit."""
defaultWeightUnit: WeightUnitsEnum
"""Returns translated shop fields for the given language code."""
translation(
"""A language code to return the translation for shop."""
languageCode: LanguageCodeEnum!
): ShopTranslation
"""
Enable automatic fulfillment for all digital products.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
automaticFulfillmentDigitalProducts: Boolean
"""
Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
reserveStockDurationAnonymousUser: Int
"""
Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
reserveStockDurationAuthenticatedUser: Int
"""
Default number of maximum line quantity in single checkout (per single checkout line).
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
limitQuantityPerCheckout: Int
"""
Default number of max downloads per digital content URL.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
defaultDigitalMaxDownloads: Int
"""
Default number of days which digital content URL will be valid.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
defaultDigitalUrlValidDays: Int
"""Company address."""
companyAddress: Address
"""URL of a view where customers can set their password."""
customerSetPasswordUrl: String
"""
List of staff notification recipients.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
staffNotificationRecipients: [StaffNotificationRecipient!]
"""
Resource limitations and current usage if any set for a shop
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
limits: LimitInfo!
"""
Saleor API version.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
version: String!
"""Include taxes in prices."""
includeTaxesInPrices: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax.")
"""Display prices with tax in store."""
displayGrossPrices: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to determine whether to display gross or net prices.")
"""Charge taxes on shipping."""
chargeTaxesOnShipping: Boolean! @deprecated(reason: "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.")
}
"""
Update the shop's address. If the `null` value is passed, the currently selected address will be deleted.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
type ShopAddressUpdate {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShopError!]!
}
"""
Updates site domain of the shop.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
type ShopDomainUpdate {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShopError!]!
}
type ShopError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: ShopErrorCode!
}
"""An enumeration."""
enum ShopErrorCode {
ALREADY_EXISTS
CANNOT_FETCH_TAX_RATES
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
"""
Fetch tax rates.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
type ShopFetchTaxRates {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShopError!]!
}
input ShopSettingsInput {
"""Header text."""
headerText: String
"""SEO description."""
description: String
"""Enable inventory tracking."""
trackInventoryByDefault: Boolean
"""Default weight unit."""
defaultWeightUnit: WeightUnitsEnum
"""Enable automatic fulfillment for all digital products."""
automaticFulfillmentDigitalProducts: Boolean
"""
Enable automatic approval of all new fulfillments.
Added in Saleor 3.1.
"""
fulfillmentAutoApprove: Boolean
"""
Enable ability to approve fulfillments which are unpaid.
Added in Saleor 3.1.
"""
fulfillmentAllowUnpaid: Boolean
"""Default number of max downloads per digital content URL."""
defaultDigitalMaxDownloads: Int
"""Default number of days which digital content URL will be valid."""
defaultDigitalUrlValidDays: Int
"""Default email sender's name."""
defaultMailSenderName: String
"""Default email sender's address."""
defaultMailSenderAddress: String
"""URL of a view where customers can set their password."""
customerSetPasswordUrl: String
"""
Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable.
Added in Saleor 3.1.
"""
reserveStockDurationAnonymousUser: Int
"""
Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable.
Added in Saleor 3.1.
"""
reserveStockDurationAuthenticatedUser: Int
"""
Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
limitQuantityPerCheckout: Int
"""
Include taxes in prices.
DEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.
"""
includeTaxesInPrices: Boolean
"""
Display prices with tax in store.
DEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.
"""
displayGrossPrices: Boolean
"""
Charge taxes on shipping.
DEPRECATED: 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.
"""
chargeTaxesOnShipping: Boolean
}
"""
Creates/updates translations for shop settings.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type ShopSettingsTranslate {
"""Updated shop settings."""
shop: Shop
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
}
input ShopSettingsTranslationInput {
headerText: String
description: String
}
"""
Updates shop settings.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
type ShopSettingsUpdate {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShopError!]!
}
type ShopTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
headerText: String!
description: String!
}
input SiteDomainInput {
"""Domain name for shop."""
domain: String
"""Shop site name."""
name: String
}
"""
Deletes staff users. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
type StaffBulkDelete {
"""Returns how many objects were affected."""
count: Int!
staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [StaffError!]!
}
"""
Creates a new staff user. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
type StaffCreate {
staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [StaffError!]!
user: User
}
input StaffCreateInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""The unique email address of the user."""
email: String
"""User account is active."""
isActive: Boolean
"""A note about the user."""
note: String
"""List of permission group IDs to which user should be assigned."""
addGroups: [ID!]
"""
URL of a view where users should be redirected to set the password. URL in RFC 1808 format.
"""
redirectUrl: String
}
"""
Event sent when new staff user is created.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type StaffCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The user the event relates to."""
user: User
}
"""
Deletes a staff user. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
type StaffDelete {
staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [StaffError!]!
user: User
}
"""
Event sent when staff user is deleted.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type StaffDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The user the event relates to."""
user: User
}
type StaffError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: AccountErrorCode!
"""A type of address that causes the error."""
addressType: AddressTypeEnum
"""List of permissions which causes the error."""
permissions: [PermissionEnum!]
"""List of permission group IDs which cause the error."""
groups: [ID!]
"""List of user IDs which causes the error."""
users: [ID!]
}
enum StaffMemberStatus {
"""User account has been activated."""
ACTIVE
"""User account has not been activated yet."""
DEACTIVATED
}
"""
Represents a recipient of email notifications send by Saleor, such as notifications about new orders. Notifications can be assigned to staff users or arbitrary email addresses.
"""
type StaffNotificationRecipient implements Node {
id: ID!
"""Returns a user subscribed to email notifications."""
user: User
"""Returns email address of a user subscribed to email notifications."""
email: String
"""Determines if a notification active."""
active: Boolean
}
"""
Creates a new staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
type StaffNotificationRecipientCreate {
shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
}
"""
Delete staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
type StaffNotificationRecipientDelete {
shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
}
input StaffNotificationRecipientInput {
"""The ID of the user subscribed to email notifications.."""
user: ID
"""Email address of a user subscribed to email notifications."""
email: String
"""Determines if a notification active."""
active: Boolean
}
"""
Updates a staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
type StaffNotificationRecipientUpdate {
shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
}
"""
Updates an existing staff user. Apps are not allowed to perform this mutation.
Requires one of the following permissions: MANAGE_STAFF.
"""
type StaffUpdate {
staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [StaffError!]!
user: User
}
input StaffUpdateInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""The unique email address of the user."""
email: String
"""User account is active."""
isActive: Boolean
"""A note about the user."""
note: String
"""List of permission group IDs to which user should be assigned."""
addGroups: [ID!]
"""List of permission group IDs from which user should be unassigned."""
removeGroups: [ID!]
}
"""
Event sent when staff user is updated.
Added in Saleor 3.5.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type StaffUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The user the event relates to."""
user: User
}
input StaffUserInput {
status: StaffMemberStatus
search: String
ids: [ID!]
}
"""Represents stock."""
type Stock implements Node {
id: ID!
warehouse: Warehouse!
productVariant: ProductVariant!
"""
Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
quantity: Int!
"""
Quantity allocated for orders.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
quantityAllocated: Int!
"""
Quantity reserved for checkouts.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
quantityReserved: Int!
}
enum StockAvailability {
IN_STOCK
OUT_OF_STOCK
}
type StockCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [StockCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type StockCountableEdge {
"""The item at the end of the edge."""
node: Stock!
"""A cursor for use in pagination."""
cursor: String!
}
type StockError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: StockErrorCode!
}
"""An enumeration."""
enum StockErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input StockFilterInput {
quantity: Float
search: String
}
input StockInput {
"""Warehouse in which stock is located."""
warehouse: ID!
"""Quantity of items available for sell."""
quantity: Int!
}
"""
Represents the channel stock settings.
Added in Saleor 3.7.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type StockSettings {
"""
Allocation strategy defines the preference of warehouses for allocations and reservations.
"""
allocationStrategy: AllocationStrategyEnum!
}
input StockSettingsInput {
"""
Allocation strategy options. Strategy defines the preference of warehouses for allocations and reservations.
"""
allocationStrategy: AllocationStrategyEnum!
}
"""Enum representing the type of a payment storage in a gateway."""
enum StorePaymentMethodEnum {
"""
On session storage type. The payment is stored only to be reused when the customer is present in the checkout flow.
"""
ON_SESSION
"""
Off session storage type. The payment is stored to be reused even if the customer is absent.
"""
OFF_SESSION
"""Storage is disabled. The payment is not stored."""
NONE
}
type Subscription {
"""
Look up subscription event.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
event: Event
}
enum TaxCalculationStrategy {
FLAT_RATES
TAX_APP
}
"""
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.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TaxClass implements Node & ObjectWithMetadata {
"""The ID of the object."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""Name of the tax class."""
name: String!
"""Country-specific tax rates for this tax class."""
countries: [TaxClassCountryRate!]!
}
type TaxClassCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [TaxClassCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type TaxClassCountableEdge {
"""The item at the end of the edge."""
node: TaxClass!
"""A cursor for use in pagination."""
cursor: String!
}
"""
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.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TaxClassCountryRate {
"""Country in which this tax rate applies."""
country: CountryDisplay!
"""Tax rate value."""
rate: Float!
"""Related tax class."""
taxClass: TaxClass
}
"""
Create a tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
type TaxClassCreate {
errors: [TaxClassCreateError!]!
taxClass: TaxClass
}
type TaxClassCreateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TaxClassCreateErrorCode!
"""List of country codes for which the configuration is invalid."""
countryCodes: [String!]!
}
"""An enumeration."""
enum TaxClassCreateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
input TaxClassCreateInput {
"""Name of the tax class."""
name: String!
"""List of country-specific tax rates to create for this tax class."""
createCountryRates: [CountryRateInput!]
}
"""
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.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
type TaxClassDelete {
errors: [TaxClassDeleteError!]!
taxClass: TaxClass
}
type TaxClassDeleteError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TaxClassDeleteErrorCode!
}
"""An enumeration."""
enum TaxClassDeleteErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
input TaxClassFilterInput {
metadata: [MetadataFilter!]
ids: [ID!]
countries: [CountryCode!]
}
input TaxClassRateInput {
"""ID of a tax class for which to update the tax rate"""
taxClassId: ID
"""Tax rate value."""
rate: Float
}
enum TaxClassSortField {
"""Sort tax classes by name."""
NAME
}
input TaxClassSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort tax classes by the selected field."""
field: TaxClassSortField!
}
"""
Update a tax class.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
type TaxClassUpdate {
errors: [TaxClassUpdateError!]!
taxClass: TaxClass
}
type TaxClassUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TaxClassUpdateErrorCode!
"""List of country codes for which the configuration is invalid."""
countryCodes: [String!]!
}
"""An enumeration."""
enum TaxClassUpdateErrorCode {
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
input TaxClassUpdateInput {
"""Name of the tax class."""
name: String
"""
List of country-specific tax rates to create or update for this tax class.
"""
updateCountryRates: [CountryRateUpdateInput!]
"""
List of country codes for which to remove the tax class rates. Note: It removes all rates for given country code.
"""
removeCountryRates: [CountryCode!]
}
"""
Channel-specific tax configuration.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TaxConfiguration implements Node & ObjectWithMetadata {
"""The ID of the object."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""A channel to which the tax configuration applies to."""
channel: Channel!
"""Determines whether taxes are charged in the given channel."""
chargeTaxes: Boolean!
"""
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.
"""
taxCalculationStrategy: TaxCalculationStrategy
"""
Determines whether prices displayed in a storefront should include taxes.
"""
displayGrossPrices: Boolean!
"""Determines whether prices are entered with the tax included."""
pricesEnteredWithTax: Boolean!
"""List of country-specific exceptions in tax configuration."""
countries: [TaxConfigurationPerCountry!]!
}
type TaxConfigurationCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [TaxConfigurationCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type TaxConfigurationCountableEdge {
"""The item at the end of the edge."""
node: TaxConfiguration!
"""A cursor for use in pagination."""
cursor: String!
}
input TaxConfigurationFilterInput {
metadata: [MetadataFilter!]
ids: [ID!]
}
"""
Country-specific exceptions of a channel's tax configuration.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TaxConfigurationPerCountry {
"""Country in which this configuration applies."""
country: CountryDisplay!
"""Determines whether taxes are charged in this country."""
chargeTaxes: Boolean!
"""
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.
"""
taxCalculationStrategy: TaxCalculationStrategy
"""
Determines whether prices displayed in a storefront should include taxes for this country.
"""
displayGrossPrices: Boolean!
}
input TaxConfigurationPerCountryInput {
"""Country in which this configuration applies."""
countryCode: CountryCode!
"""Determines whether taxes are charged in this country."""
chargeTaxes: Boolean!
"""
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.
"""
taxCalculationStrategy: TaxCalculationStrategy
"""
Determines whether prices displayed in a storefront should include taxes for this country.
"""
displayGrossPrices: Boolean!
}
"""
Update tax configuration for a channel.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
type TaxConfigurationUpdate {
errors: [TaxConfigurationUpdateError!]!
taxConfiguration: TaxConfiguration
}
type TaxConfigurationUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TaxConfigurationUpdateErrorCode!
"""List of country codes for which the configuration is invalid."""
countryCodes: [String!]!
}
"""An enumeration."""
enum TaxConfigurationUpdateErrorCode {
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
input TaxConfigurationUpdateInput {
"""Determines whether taxes are charged in the given channel."""
chargeTaxes: Boolean
"""
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.
"""
taxCalculationStrategy: TaxCalculationStrategy
"""
Determines whether prices displayed in a storefront should include taxes.
"""
displayGrossPrices: Boolean
"""Determines whether prices are entered with the tax included."""
pricesEnteredWithTax: Boolean
"""
List of tax country configurations to create or update (identified by a country code).
"""
updateCountriesConfiguration: [TaxConfigurationPerCountryInput!]
"""List of country codes for which to remove the tax configuration."""
removeCountriesConfiguration: [CountryCode!]
}
"""
Tax class rates grouped by country.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TaxCountryConfiguration {
"""A country for which tax class rates are grouped."""
country: CountryDisplay!
"""List of tax class rates."""
taxClassCountryRates: [TaxClassCountryRate!]!
}
"""
Remove all tax class rates for a specific country.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
type TaxCountryConfigurationDelete {
"""Updated tax class rates grouped by a country."""
taxCountryConfiguration: TaxCountryConfiguration
errors: [TaxCountryConfigurationDeleteError!]!
}
type TaxCountryConfigurationDeleteError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TaxCountryConfigurationDeleteErrorCode!
}
"""An enumeration."""
enum TaxCountryConfigurationDeleteErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
"""
Update tax class rates for a specific country.
Added in Saleor 3.9.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
type TaxCountryConfigurationUpdate {
"""Updated tax class rates grouped by a country."""
taxCountryConfiguration: TaxCountryConfiguration
errors: [TaxCountryConfigurationUpdateError!]!
}
type TaxCountryConfigurationUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TaxCountryConfigurationUpdateErrorCode!
"""List of tax class IDs for which the update failed."""
taxClassIds: [String!]!
}
"""An enumeration."""
enum TaxCountryConfigurationUpdateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
ONLY_ONE_DEFAULT_COUNTRY_RATE_ALLOWED
CANNOT_CREATE_NEGATIVE_RATE
}
"""
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.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: MANAGE_TAXES.
"""
type TaxExemptionManage {
taxableObject: TaxSourceObject
errors: [TaxExemptionManageError!]!
}
type TaxExemptionManageError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TaxExemptionManageErrorCode!
}
"""An enumeration."""
enum TaxExemptionManageErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
NOT_EDITABLE_ORDER
}
union TaxSourceLine = CheckoutLine | OrderLine
union TaxSourceObject = Checkout | Order
"""Representation of tax types fetched from tax gateway."""
type TaxType {
"""Description of the tax type."""
description: String
"""External tax code used to identify given tax group."""
taxCode: String
}
"""Taxable object."""
type TaxableObject {
"""The source object related to this tax object."""
sourceObject: TaxSourceObject!
"""Determines if prices contain entered tax.."""
pricesEnteredWithTax: Boolean!
"""The currency of the object."""
currency: String!
"""The price of shipping method."""
shippingPrice: Money!
"""The address data."""
address: Address
"""List of discounts."""
discounts: [TaxableObjectDiscount!]!
"""List of lines assigned to the object."""
lines: [TaxableObjectLine!]!
channel: Channel!
}
"""Taxable object discount."""
type TaxableObjectDiscount {
"""The name of the discount."""
name: String
"""The amount of the discount."""
amount: Money!
}
type TaxableObjectLine {
"""The source line related to this tax line."""
sourceLine: TaxSourceLine!
"""Number of items."""
quantity: Int!
"""Determines if taxes are being charged for the product."""
chargeTaxes: Boolean!
"""The product name."""
productName: String!
"""The variant name."""
variantName: String!
"""The product sku."""
productSku: String
"""Price of the single item in the order line."""
unitPrice: Money!
"""Price of the order line."""
totalPrice: Money!
}
"""
Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal.
"""
type TaxedMoney {
"""Currency code."""
currency: String!
"""Amount of money including taxes."""
gross: Money!
"""Amount of money without taxes."""
net: Money!
"""Amount of taxes."""
tax: Money!
}
"""Represents a range of monetary values."""
type TaxedMoneyRange {
"""Lower bound of a price range."""
start: TaxedMoney
"""Upper bound of a price range."""
stop: TaxedMoney
}
"""An enumeration."""
enum ThumbnailFormatEnum {
WEBP
}
type TimePeriod {
"""The length of the period."""
amount: Int!
"""The type of the period."""
type: TimePeriodTypeEnum!
}
input TimePeriodInputType {
"""The length of the period."""
amount: Int!
"""The type of the period."""
type: TimePeriodTypeEnum!
}
"""An enumeration."""
enum TimePeriodTypeEnum {
DAY
WEEK
MONTH
YEAR
}
"""An object representing a single payment."""
type Transaction implements Node {
id: ID!
created: DateTime!
payment: Payment!
token: String!
kind: TransactionKind!
isSuccess: Boolean!
error: String
gatewayResponse: JSONString!
"""Total amount of the transaction."""
amount: Money
}
type TransactionAction {
"""Determines the action type."""
actionType: TransactionActionEnum!
"""Transaction request amount. Null when action type is VOID."""
amount: PositiveDecimal
}
"""
Represents possible actions on payment transaction.
The following actions are possible:
CHARGE - Represents the charge action.
REFUND - Represents a refund action.
VOID - Represents a void action.
"""
enum TransactionActionEnum {
CHARGE
REFUND
VOID
}
"""
Event sent when transaction action is requested.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TransactionActionRequest implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""
Look up a transaction.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
transaction: TransactionItem
"""
Requested action data.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
action: TransactionAction!
}
"""
Create transaction for checkout or order. Requires the following permissions: AUTHENTICATED_APP and HANDLE_PAYMENTS.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TransactionCreate {
transaction: TransactionItem
errors: [TransactionCreateError!]!
}
type TransactionCreateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TransactionCreateErrorCode!
}
"""An enumeration."""
enum TransactionCreateErrorCode {
INVALID
GRAPHQL_ERROR
NOT_FOUND
INCORRECT_CURRENCY
METADATA_KEY_REQUIRED
}
input TransactionCreateInput {
"""Status of the transaction."""
status: String!
"""Payment type used for this transaction."""
type: String!
"""Reference of the transaction."""
reference: String
"""List of all possible actions for the transaction"""
availableActions: [TransactionActionEnum!]
"""Amount authorized by this transaction."""
amountAuthorized: MoneyInput
"""Amount charged by this transaction."""
amountCharged: MoneyInput
"""Amount refunded by this transaction."""
amountRefunded: MoneyInput
"""Amount voided by this transaction."""
amountVoided: MoneyInput
"""Payment public metadata."""
metadata: [MetadataInput!]
"""Payment private metadata."""
privateMetadata: [MetadataInput!]
}
"""Represents transaction's event."""
type TransactionEvent implements Node {
"""The ID of the object."""
id: ID!
createdAt: DateTime!
"""Status of transaction's event."""
status: TransactionStatus!
"""Reference of transaction's event."""
reference: String!
"""Name of the transaction's event."""
name: String
}
input TransactionEventInput {
"""Current status of the payment transaction."""
status: TransactionStatus!
"""Reference of the transaction."""
reference: String
"""Name of the transaction."""
name: String
}
"""
Represents a payment transaction.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TransactionItem implements Node & ObjectWithMetadata {
"""The ID of the object."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
createdAt: DateTime!
modifiedAt: DateTime!
"""
List of actions that can be performed in the current state of a payment.
"""
actions: [TransactionActionEnum!]!
"""Total amount authorized for this payment."""
authorizedAmount: Money!
"""Total amount refunded for this payment."""
refundedAmount: Money!
"""Total amount voided for this payment."""
voidedAmount: Money!
"""Total amount charged for this payment."""
chargedAmount: Money!
"""Status of transaction."""
status: String!
"""Type of transaction."""
type: String!
"""Reference of transaction."""
reference: String!
"""
The related order.
Added in Saleor 3.6.
"""
order: Order
"""List of all transaction's events."""
events: [TransactionEvent!]!
}
"""
Event sent when transaction item metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TransactionItemMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""
Look up a transaction.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
transaction: TransactionItem
}
"""An enumeration."""
enum TransactionKind {
EXTERNAL
AUTH
PENDING
ACTION_TO_CONFIRM
REFUND
REFUND_ONGOING
CAPTURE
VOID
CONFIRM
CANCEL
}
"""
Request an action for payment transaction.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
"""
type TransactionRequestAction {
transaction: TransactionItem
errors: [TransactionRequestActionError!]!
}
type TransactionRequestActionError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TransactionRequestActionErrorCode!
}
"""An enumeration."""
enum TransactionRequestActionErrorCode {
INVALID
GRAPHQL_ERROR
NOT_FOUND
MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK
}
"""An enumeration."""
enum TransactionStatus {
PENDING
SUCCESS
FAILURE
}
"""
Create transaction for checkout or order. Requires the following permissions: AUTHENTICATED_APP and HANDLE_PAYMENTS.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TransactionUpdate {
transaction: TransactionItem
errors: [TransactionUpdateError!]!
}
type TransactionUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TransactionUpdateErrorCode!
}
"""An enumeration."""
enum TransactionUpdateErrorCode {
INVALID
GRAPHQL_ERROR
NOT_FOUND
INCORRECT_CURRENCY
METADATA_KEY_REQUIRED
}
input TransactionUpdateInput {
"""Status of the transaction."""
status: String
"""Payment type used for this transaction."""
type: String
"""Reference of the transaction."""
reference: String
"""List of all possible actions for the transaction"""
availableActions: [TransactionActionEnum!]
"""Amount authorized by this transaction."""
amountAuthorized: MoneyInput
"""Amount charged by this transaction."""
amountCharged: MoneyInput
"""Amount refunded by this transaction."""
amountRefunded: MoneyInput
"""Amount voided by this transaction."""
amountVoided: MoneyInput
"""Payment public metadata."""
metadata: [MetadataInput!]
"""Payment private metadata."""
privateMetadata: [MetadataInput!]
}
union TranslatableItem = ProductTranslatableContent | CollectionTranslatableContent | CategoryTranslatableContent | AttributeTranslatableContent | AttributeValueTranslatableContent | ProductVariantTranslatableContent | PageTranslatableContent | ShippingMethodTranslatableContent | SaleTranslatableContent | VoucherTranslatableContent | MenuItemTranslatableContent
type TranslatableItemConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [TranslatableItemEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type TranslatableItemEdge {
"""The item at the end of the edge."""
node: TranslatableItem!
"""A cursor for use in pagination."""
cursor: String!
}
enum TranslatableKinds {
ATTRIBUTE
ATTRIBUTE_VALUE
CATEGORY
COLLECTION
MENU_ITEM
PAGE
PRODUCT
SALE
SHIPPING_METHOD
VARIANT
VOUCHER
}
"""
Event sent when new translation is created.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TranslationCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The translation the event relates to."""
translation: TranslationTypes
}
type TranslationError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: TranslationErrorCode!
}
"""An enumeration."""
enum TranslationErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
}
input TranslationInput {
seoTitle: String
seoDescription: String
name: String
"""
Translated description.
Rich text format. For reference see https://editorjs.io/
"""
description: JSONString
}
union TranslationTypes = ProductTranslation | CollectionTranslation | CategoryTranslation | AttributeTranslation | AttributeValueTranslation | ProductVariantTranslation | PageTranslation | ShippingMethodTranslation | SaleTranslation | VoucherTranslation | MenuItemTranslation
"""
Event sent when translation is updated.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type TranslationUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The translation the event relates to."""
translation: TranslationTypes
}
scalar UUID
input UpdateInvoiceInput {
"""Invoice number"""
number: String
"""URL of an invoice to download."""
url: String
}
"""
Updates metadata of an object. To use it, you need to have access to the modified object.
"""
type UpdateMetadata {
metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MetadataError!]!
item: ObjectWithMetadata
}
"""
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.
"""
type UpdatePrivateMetadata {
metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [MetadataError!]!
item: ObjectWithMetadata
}
"""
Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec.
"""
scalar Upload
type UploadError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: UploadErrorCode!
}
"""An enumeration."""
enum UploadErrorCode {
GRAPHQL_ERROR
}
"""Represents user data."""
type User implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
email: String!
firstName: String!
lastName: String!
isStaff: Boolean!
isActive: Boolean!
"""List of all user's addresses."""
addresses: [Address!]!
"""Returns the last open checkout of this user."""
checkout: Checkout @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `checkoutTokens` field to fetch the user checkouts.")
"""Returns the checkout UUID's assigned to this user."""
checkoutTokens(
"""Slug of a channel for which the data should be returned."""
channel: String
): [UUID!] @deprecated(reason: "This field will be removed in Saleor 4.0. Use `checkoutIds` instead.")
"""Returns the checkout ID's assigned to this user."""
checkoutIds(
"""Slug of a channel for which the data should be returned."""
channel: String
): [ID!]
"""
Returns checkouts assigned to this user.
Added in Saleor 3.8.
"""
checkouts(
"""Slug of a channel for which the data should be returned."""
channel: String
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CheckoutCountableConnection
"""List of the user gift cards."""
giftCards(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): GiftCardCountableConnection
"""
A note about the customer.
Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.
"""
note: String
"""
List of user's orders. Requires one of the following permissions: MANAGE_STAFF, OWNER.
"""
orders(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): OrderCountableConnection
"""List of user's permissions."""
userPermissions: [UserPermission!]
"""List of user's permission groups."""
permissionGroups: [Group!]
"""List of user's permission groups which user can manage."""
editableGroups: [Group!]
avatar(
"""
Size of the image. If not provided, the original image will be returned.
"""
size: Int
"""
The format of the image. When not provided, format of the original image will be used. Must be provided together with the size value, otherwise original image will be returned.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
format: ThumbnailFormatEnum
): Image
"""
List of events associated with the user.
Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.
"""
events: [CustomerEvent!]
"""List of stored payment sources."""
storedPaymentSources(
"""Slug of a channel for which the data should be returned."""
channel: String
): [PaymentSource!]
"""User language code."""
languageCode: LanguageCodeEnum!
defaultShippingAddress: Address
defaultBillingAddress: Address
lastLogin: DateTime
dateJoined: DateTime!
updatedAt: DateTime!
}
"""
Deletes a user avatar. Only for staff members.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
type UserAvatarDelete {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
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
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
type UserAvatarUpdate {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Activate or deactivate users.
Requires one of the following permissions: MANAGE_USERS.
"""
type UserBulkSetActive {
"""Returns how many objects were affected."""
count: Int!
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
type UserCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [UserCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type UserCountableEdge {
"""The item at the end of the edge."""
node: User!
"""A cursor for use in pagination."""
cursor: String!
}
input UserCreateInput {
"""Billing address of the customer."""
defaultBillingAddress: AddressInput
"""Shipping address of the customer."""
defaultShippingAddress: AddressInput
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""The unique email address of the user."""
email: String
"""User account is active."""
isActive: Boolean
"""A note about the user."""
note: String
"""User language code."""
languageCode: LanguageCodeEnum
"""
URL of a view where users should be redirected to set the password. URL in RFC 1808 format.
"""
redirectUrl: String
"""
Slug of a channel which will be used for notify user. Optional when only one channel exists.
"""
channel: String
}
type UserPermission {
"""Internal code for permission."""
code: PermissionEnum!
"""Describe action(s) allowed to do by permission."""
name: String!
"""List of user permission groups which contains this permission."""
sourcePermissionGroups(
"""ID of user whose groups should be returned."""
userId: ID!
): [Group!]
}
enum UserSortField {
"""Sort users by first name."""
FIRST_NAME
"""Sort users by last name."""
LAST_NAME
"""Sort users by email."""
EMAIL
"""Sort users by order count."""
ORDER_COUNT
"""Sort users by created at."""
CREATED_AT
"""Sort users by last modified at."""
LAST_MODIFIED_AT
}
input UserSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort users by the selected field."""
field: UserSortField!
}
"""Represents a VAT rate for a country."""
type VAT {
"""Country code."""
countryCode: String!
"""Standard VAT rate in percent."""
standardRate: Float
"""Country's VAT rate exceptions for specific types of goods."""
reducedRates: [ReducedRate!]!
}
enum VariantAttributeScope {
ALL
VARIANT_SELECTION
NOT_VARIANT_SELECTION
}
"""
Assign an media to a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type VariantMediaAssign {
productVariant: ProductVariant
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""
Unassign an media from a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type VariantMediaUnassign {
productVariant: ProductVariant
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [ProductError!]!
}
"""Represents availability of a variant in the storefront."""
type VariantPricingInfo {
"""Whether it is in sale or not."""
onSale: Boolean
"""The discount amount if in sale (null otherwise)."""
discount: TaxedMoney
"""The discount amount in the local currency."""
discountLocalCurrency: TaxedMoney
"""The price, with any discount subtracted."""
price: TaxedMoney
"""The price without any discount."""
priceUndiscounted: TaxedMoney
"""The discounted price in the local currency."""
priceLocalCurrency: TaxedMoney
}
"""Verify JWT token."""
type VerifyToken {
"""User assigned to token."""
user: User
"""Determine if token is valid or not."""
isValid: Boolean!
"""JWT payload."""
payload: GenericScalar
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""An enumeration."""
enum VolumeUnitsEnum {
CUBIC_MILLIMETER
CUBIC_CENTIMETER
CUBIC_DECIMETER
CUBIC_METER
LITER
CUBIC_FOOT
CUBIC_INCH
CUBIC_YARD
QT
PINT
FL_OZ
ACRE_IN
ACRE_FT
}
"""
Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.
"""
type Voucher implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String
code: String!
usageLimit: Int
used: Int!
startDate: DateTime!
endDate: DateTime
applyOncePerOrder: Boolean!
applyOncePerCustomer: Boolean!
onlyForStaff: Boolean!
minCheckoutItemsQuantity: Int
"""List of categories this voucher applies to."""
categories(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CategoryCountableConnection
"""
List of collections this voucher applies to.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
collections(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): CollectionCountableConnection
"""
List of products this voucher applies to.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
products(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductCountableConnection
"""
List of product variants this voucher applies to.
Added in Saleor 3.1.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
variants(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ProductVariantCountableConnection
"""List of countries available for the shipping voucher."""
countries: [CountryDisplay!]
"""Returns translated voucher fields for the given language code."""
translation(
"""A language code to return the translation for voucher."""
languageCode: LanguageCodeEnum!
): VoucherTranslation
"""Determines a type of discount for voucher - value or percentage"""
discountValueType: DiscountValueTypeEnum!
"""Voucher value."""
discountValue: Float
"""Currency code for voucher."""
currency: String
"""Minimum order value to apply voucher."""
minSpent: Money
"""Determines a type of voucher."""
type: VoucherTypeEnum!
"""
List of availability in channels for the voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
channelListings: [VoucherChannelListing!]
}
"""
Adds products, categories, collections to a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type VoucherAddCatalogues {
"""Voucher of which catalogue IDs will be modified."""
voucher: Voucher
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
"""
Deletes vouchers.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type VoucherBulkDelete {
"""Returns how many objects were affected."""
count: Int!
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
"""Represents voucher channel listing."""
type VoucherChannelListing implements Node {
id: ID!
channel: Channel!
discountValue: Float!
currency: String!
minSpent: Money
}
input VoucherChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
"""Value of the voucher."""
discountValue: PositiveDecimal
"""Min purchase amount required to apply the voucher."""
minAmountSpent: PositiveDecimal
}
input VoucherChannelListingInput {
"""List of channels to which the voucher should be assigned."""
addChannels: [VoucherChannelListingAddInput!]
"""List of channels from which the voucher should be unassigned."""
removeChannels: [ID!]
}
"""
Manage voucher's availability in channels.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type VoucherChannelListingUpdate {
"""An updated voucher instance."""
voucher: Voucher
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
type VoucherCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [VoucherCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type VoucherCountableEdge {
"""The item at the end of the edge."""
node: Voucher!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type VoucherCreate {
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
voucher: Voucher
}
"""
Event sent when new voucher is created.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type VoucherCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The voucher the event relates to."""
voucher(
"""Slug of a channel for which the data should be returned."""
channel: String
): Voucher
}
"""
Deletes a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type VoucherDelete {
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
voucher: Voucher
}
"""
Event sent when voucher is deleted.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type VoucherDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The voucher the event relates to."""
voucher(
"""Slug of a channel for which the data should be returned."""
channel: String
): Voucher
}
enum VoucherDiscountType {
FIXED
PERCENTAGE
SHIPPING
}
input VoucherFilterInput {
status: [DiscountStatusEnum!]
timesUsed: IntRangeInput
discountType: [VoucherDiscountType!]
started: DateTimeRangeInput
search: String
metadata: [MetadataFilter!]
ids: [ID!]
}
input VoucherInput {
"""Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER."""
type: VoucherTypeEnum
"""Voucher name."""
name: String
"""Code to use the voucher."""
code: String
"""Start date of the voucher in ISO 8601 format."""
startDate: DateTime
"""End date of the voucher in ISO 8601 format."""
endDate: DateTime
"""Choices: fixed or percentage."""
discountValueType: DiscountValueTypeEnum
"""Products discounted by the voucher."""
products: [ID!]
"""
Variants discounted by the voucher.
Added in Saleor 3.1.
"""
variants: [ID!]
"""Collections discounted by the voucher."""
collections: [ID!]
"""Categories discounted by the voucher."""
categories: [ID!]
"""Minimal quantity of checkout items required to apply the voucher."""
minCheckoutItemsQuantity: Int
"""Country codes that can be used with the shipping voucher."""
countries: [String!]
"""Voucher should be applied to the cheapest item or entire order."""
applyOncePerOrder: Boolean
"""Voucher should be applied once per customer."""
applyOncePerCustomer: Boolean
"""Voucher can be used only by staff user."""
onlyForStaff: Boolean
"""Limit number of times this voucher can be used in total."""
usageLimit: Int
}
"""
Event sent when voucher metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type VoucherMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The voucher the event relates to."""
voucher(
"""Slug of a channel for which the data should be returned."""
channel: String
): Voucher
}
"""
Removes products, categories, collections from a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type VoucherRemoveCatalogues {
"""Voucher of which catalogue IDs will be modified."""
voucher: Voucher
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
}
enum VoucherSortField {
"""Sort vouchers by code."""
CODE
"""Sort vouchers by start date."""
START_DATE
"""Sort vouchers by end date."""
END_DATE
"""
Sort vouchers by value.
This option requires a channel filter to work as the values can vary between channels.
"""
VALUE
"""Sort vouchers by type."""
TYPE
"""Sort vouchers by usage limit."""
USAGE_LIMIT
"""
Sort vouchers by minimum spent amount.
This option requires a channel filter to work as the values can vary between channels.
"""
MINIMUM_SPENT_AMOUNT
}
input VoucherSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""
Specifies the channel in which to sort the data.
DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead.
"""
channel: String
"""Sort vouchers by the selected field."""
field: VoucherSortField!
}
type VoucherTranslatableContent implements Node {
id: ID!
name: String
"""Returns translated voucher fields for the given language code."""
translation(
"""A language code to return the translation for voucher."""
languageCode: LanguageCodeEnum!
): VoucherTranslation
"""
Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
voucher: Voucher @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.")
}
"""
Creates/updates translations for a voucher.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
type VoucherTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [TranslationError!]!
voucher: Voucher
}
type VoucherTranslation implements Node {
id: ID!
"""Translation language."""
language: LanguageDisplay!
name: String
}
enum VoucherTypeEnum {
SHIPPING
ENTIRE_ORDER
SPECIFIC_PRODUCT
}
"""
Updates a voucher.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
type VoucherUpdate {
discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [DiscountError!]!
voucher: Voucher
}
"""
Event sent when voucher is updated.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type VoucherUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The voucher the event relates to."""
voucher(
"""Slug of a channel for which the data should be returned."""
channel: String
): Voucher
}
"""Represents warehouse."""
type Warehouse implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
name: String!
slug: String!
email: String!
isPrivate: Boolean!
address: Address!
"""Warehouse company name."""
companyName: String! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `Address.companyName` instead.")
"""
Click and collect options: local, all or disabled.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
clickAndCollectOption: WarehouseClickAndCollectOptionEnum!
shippingZones(
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): ShippingZoneCountableConnection!
}
"""An enumeration."""
enum WarehouseClickAndCollectOptionEnum {
DISABLED
LOCAL
ALL
}
type WarehouseCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [WarehouseCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type WarehouseCountableEdge {
"""The item at the end of the edge."""
node: Warehouse!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates new warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type WarehouseCreate {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
}
input WarehouseCreateInput {
"""Warehouse slug."""
slug: String
"""The email address of the warehouse."""
email: String
"""Warehouse name."""
name: String!
"""Address of the warehouse."""
address: AddressInput!
"""
Shipping zones supported by the warehouse.
DEPRECATED: this field will be removed in Saleor 4.0. Providing the zone ids will raise a ValidationError.
"""
shippingZones: [ID!]
}
"""
Event sent when new warehouse is created.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type WarehouseCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The warehouse the event relates to."""
warehouse: Warehouse
}
"""
Deletes selected warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type WarehouseDelete {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
}
"""
Event sent when warehouse is deleted.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type WarehouseDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The warehouse the event relates to."""
warehouse: Warehouse
}
type WarehouseError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: WarehouseErrorCode!
"""List of shipping zones IDs which causes the error."""
shippingZones: [ID!]
}
"""An enumeration."""
enum WarehouseErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
input WarehouseFilterInput {
clickAndCollectOption: WarehouseClickAndCollectOptionEnum
search: String
ids: [ID!]
isPrivate: Boolean
channels: [ID!]
slugs: [String!]
}
"""
Event sent when warehouse metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type WarehouseMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The warehouse the event relates to."""
warehouse: Warehouse
}
"""
Add shipping zone to given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type WarehouseShippingZoneAssign {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
}
"""
Remove shipping zone from given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type WarehouseShippingZoneUnassign {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
}
enum WarehouseSortField {
"""Sort warehouses by name."""
NAME
}
input WarehouseSortingInput {
"""Specifies the direction in which to sort products."""
direction: OrderDirection!
"""Sort warehouses by the selected field."""
field: WarehouseSortField!
}
"""
Updates given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
type WarehouseUpdate {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
}
input WarehouseUpdateInput {
"""Warehouse slug."""
slug: String
"""The email address of the warehouse."""
email: String
"""Warehouse name."""
name: String
"""Address of the warehouse."""
address: AddressInput
"""
Click and collect options: local, all or disabled.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
clickAndCollectOption: WarehouseClickAndCollectOptionEnum
"""
Visibility of warehouse stocks.
Added in Saleor 3.1.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
isPrivate: Boolean
}
"""
Event sent when warehouse is updated.
Added in Saleor 3.4.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
type WarehouseUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The warehouse the event relates to."""
warehouse: Warehouse
}
"""Webhook."""
type Webhook implements Node {
id: ID!
name: String!
"""List of webhook events."""
events: [WebhookEvent!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead.")
"""List of synchronous webhook events."""
syncEvents: [WebhookEventSync!]!
"""List of asynchronous webhook events."""
asyncEvents: [WebhookEventAsync!]!
app: App!
"""Event deliveries."""
eventDeliveries(
"""Event delivery sorter."""
sortBy: EventDeliverySortingInput
"""Event delivery filter options."""
filter: EventDeliveryFilterInput
"""Return the elements in the list that come before the specified cursor."""
before: String
"""Return the elements in the list that come after the specified cursor."""
after: String
"""Return the first n elements from the list."""
first: Int
"""Return the last n elements from the list."""
last: Int
): EventDeliveryCountableConnection
"""Target URL for webhook."""
targetUrl: String!
"""Informs if webhook is activated."""
isActive: Boolean!
"""Used to create a hash signature for each payload."""
secretKey: String @deprecated(reason: "This field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.")
"""Used to define payloads for specific events."""
subscriptionQuery: String
}
"""
Creates a new webhook subscription.
Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
"""
type WebhookCreate {
webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WebhookError!]!
webhook: Webhook
}
input WebhookCreateInput {
"""The name of the webhook."""
name: String
"""The url to receive the payload."""
targetUrl: String
"""
The events that webhook wants to subscribe.
DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead.
"""
events: [WebhookEventTypeEnum!]
"""The asynchronous events that webhook wants to subscribe."""
asyncEvents: [WebhookEventTypeAsyncEnum!]
"""The synchronous events that webhook wants to subscribe."""
syncEvents: [WebhookEventTypeSyncEnum!]
"""ID of the app to which webhook belongs."""
app: ID
"""Determine if webhook will be set active or not."""
isActive: Boolean
"""
The secret key used to create a hash signature with each payload.
DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.
"""
secretKey: String
"""
Subscription query used to define a webhook payload.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
query: String
}
"""
Deletes a webhook subscription.
Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
"""
type WebhookDelete {
webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WebhookError!]!
webhook: Webhook
}
type WebhookError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: WebhookErrorCode!
}
"""An enumeration."""
enum WebhookErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
UNIQUE
}
"""Webhook event."""
type WebhookEvent {
"""Display name of the event."""
name: String!
"""Internal name of the event type."""
eventType: WebhookEventTypeEnum!
}
"""Asynchronous webhook event."""
type WebhookEventAsync {
"""Display name of the event."""
name: String!
"""Internal name of the event type."""
eventType: WebhookEventTypeAsyncEnum!
}
"""Synchronous webhook event."""
type WebhookEventSync {
"""Display name of the event."""
name: String!
"""Internal name of the event type."""
eventType: WebhookEventTypeSyncEnum!
}
"""Enum determining type of webhook."""
enum WebhookEventTypeAsyncEnum {
"""All the events."""
ANY_EVENTS
"""A new address created."""
ADDRESS_CREATED
"""An address updated."""
ADDRESS_UPDATED
"""An address deleted."""
ADDRESS_DELETED
"""A new app installed."""
APP_INSTALLED
"""An app updated."""
APP_UPDATED
"""An app deleted."""
APP_DELETED
"""An app status is changed."""
APP_STATUS_CHANGED
"""A new attribute is created."""
ATTRIBUTE_CREATED
"""An attribute is updated."""
ATTRIBUTE_UPDATED
"""An attribute is deleted."""
ATTRIBUTE_DELETED
"""A new attribute value is created."""
ATTRIBUTE_VALUE_CREATED
"""An attribute value is updated."""
ATTRIBUTE_VALUE_UPDATED
"""An attribute value is deleted."""
ATTRIBUTE_VALUE_DELETED
"""A new category created."""
CATEGORY_CREATED
"""A category is updated."""
CATEGORY_UPDATED
"""A category is deleted."""
CATEGORY_DELETED
"""A new channel created."""
CHANNEL_CREATED
"""A channel is updated."""
CHANNEL_UPDATED
"""A channel is deleted."""
CHANNEL_DELETED
"""A channel status is changed."""
CHANNEL_STATUS_CHANGED
"""A new gift card created."""
GIFT_CARD_CREATED
"""A gift card is updated."""
GIFT_CARD_UPDATED
"""A gift card is deleted."""
GIFT_CARD_DELETED
"""A gift card status is changed."""
GIFT_CARD_STATUS_CHANGED
"""
A gift card metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
GIFT_CARD_METADATA_UPDATED
"""A new menu created."""
MENU_CREATED
"""A menu is updated."""
MENU_UPDATED
"""A menu is deleted."""
MENU_DELETED
"""A new menu item created."""
MENU_ITEM_CREATED
"""A menu item is updated."""
MENU_ITEM_UPDATED
"""A menu item is deleted."""
MENU_ITEM_DELETED
"""A new order is placed."""
ORDER_CREATED
"""
An order is confirmed (status change unconfirmed -> unfulfilled) by a staff user using the OrderConfirm mutation. It also triggers when the user completes the checkout and the shop setting `automatically_confirm_all_new_orders` is enabled.
"""
ORDER_CONFIRMED
"""Payment is made and an order is fully paid."""
ORDER_FULLY_PAID
"""
An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED.
"""
ORDER_UPDATED
"""An order is cancelled."""
ORDER_CANCELLED
"""An order is fulfilled."""
ORDER_FULFILLED
"""
An order metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
ORDER_METADATA_UPDATED
"""A draft order is created."""
DRAFT_ORDER_CREATED
"""A draft order is updated."""
DRAFT_ORDER_UPDATED
"""A draft order is deleted."""
DRAFT_ORDER_DELETED
"""A sale is created."""
SALE_CREATED
"""A sale is updated."""
SALE_UPDATED
"""A sale is deleted."""
SALE_DELETED
"""A sale is activated or deactivated."""
SALE_TOGGLE
"""An invoice for order requested."""
INVOICE_REQUESTED
"""An invoice is deleted."""
INVOICE_DELETED
"""Invoice has been sent."""
INVOICE_SENT
"""A new customer account is created."""
CUSTOMER_CREATED
"""A customer account is updated."""
CUSTOMER_UPDATED
"""A customer account is deleted."""
CUSTOMER_DELETED
"""
A customer account metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
CUSTOMER_METADATA_UPDATED
"""A new collection is created."""
COLLECTION_CREATED
"""A collection is updated."""
COLLECTION_UPDATED
"""A collection is deleted."""
COLLECTION_DELETED
"""
A collection metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
COLLECTION_METADATA_UPDATED
"""A new product is created."""
PRODUCT_CREATED
"""A product is updated."""
PRODUCT_UPDATED
"""A product is deleted."""
PRODUCT_DELETED
"""
A product metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
PRODUCT_METADATA_UPDATED
"""A new product variant is created."""
PRODUCT_VARIANT_CREATED
"""A product variant is updated."""
PRODUCT_VARIANT_UPDATED
"""A product variant is deleted."""
PRODUCT_VARIANT_DELETED
"""A product variant is out of stock."""
PRODUCT_VARIANT_OUT_OF_STOCK
"""A product variant is back in stock."""
PRODUCT_VARIANT_BACK_IN_STOCK
"""
A product variant metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
PRODUCT_VARIANT_METADATA_UPDATED
"""A new checkout is created."""
CHECKOUT_CREATED
"""
A checkout is updated. It also triggers all updates related to the checkout.
"""
CHECKOUT_UPDATED
"""
A checkout metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
CHECKOUT_METADATA_UPDATED
"""A new fulfillment is created."""
FULFILLMENT_CREATED
"""A fulfillment is cancelled."""
FULFILLMENT_CANCELED
"""A fulfillment is approved."""
FULFILLMENT_APPROVED
"""
A fulfillment metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
FULFILLMENT_METADATA_UPDATED
"""User notification triggered."""
NOTIFY_USER
"""A new page is created."""
PAGE_CREATED
"""A page is updated."""
PAGE_UPDATED
"""A page is deleted."""
PAGE_DELETED
"""A new page type is created."""
PAGE_TYPE_CREATED
"""A page type is updated."""
PAGE_TYPE_UPDATED
"""A page type is deleted."""
PAGE_TYPE_DELETED
"""A new permission group is created."""
PERMISSION_GROUP_CREATED
"""A permission group is updated."""
PERMISSION_GROUP_UPDATED
"""A permission group is deleted."""
PERMISSION_GROUP_DELETED
"""A new shipping price is created."""
SHIPPING_PRICE_CREATED
"""A shipping price is updated."""
SHIPPING_PRICE_UPDATED
"""A shipping price is deleted."""
SHIPPING_PRICE_DELETED
"""A new shipping zone is created."""
SHIPPING_ZONE_CREATED
"""A shipping zone is updated."""
SHIPPING_ZONE_UPDATED
"""A shipping zone is deleted."""
SHIPPING_ZONE_DELETED
"""
A shipping zone metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
SHIPPING_ZONE_METADATA_UPDATED
"""A new staff user is created."""
STAFF_CREATED
"""A staff user is updated."""
STAFF_UPDATED
"""A staff user is deleted."""
STAFF_DELETED
"""An action requested for transaction."""
TRANSACTION_ACTION_REQUEST
"""
Transaction item metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
TRANSACTION_ITEM_METADATA_UPDATED
"""A new translation is created."""
TRANSLATION_CREATED
"""A translation is updated."""
TRANSLATION_UPDATED
"""A new warehouse created."""
WAREHOUSE_CREATED
"""A warehouse is updated."""
WAREHOUSE_UPDATED
"""A warehouse is deleted."""
WAREHOUSE_DELETED
"""
A warehouse metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
WAREHOUSE_METADATA_UPDATED
"""A new voucher created."""
VOUCHER_CREATED
"""A voucher is updated."""
VOUCHER_UPDATED
"""A voucher is deleted."""
VOUCHER_DELETED
"""
A voucher metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
VOUCHER_METADATA_UPDATED
"""An observability event is created."""
OBSERVABILITY
}
"""Enum determining type of webhook."""
enum WebhookEventTypeEnum {
"""All the events."""
ANY_EVENTS
"""A new address created."""
ADDRESS_CREATED
"""An address updated."""
ADDRESS_UPDATED
"""An address deleted."""
ADDRESS_DELETED
"""A new app installed."""
APP_INSTALLED
"""An app updated."""
APP_UPDATED
"""An app deleted."""
APP_DELETED
"""An app status is changed."""
APP_STATUS_CHANGED
"""A new attribute is created."""
ATTRIBUTE_CREATED
"""An attribute is updated."""
ATTRIBUTE_UPDATED
"""An attribute is deleted."""
ATTRIBUTE_DELETED
"""A new attribute value is created."""
ATTRIBUTE_VALUE_CREATED
"""An attribute value is updated."""
ATTRIBUTE_VALUE_UPDATED
"""An attribute value is deleted."""
ATTRIBUTE_VALUE_DELETED
"""A new category created."""
CATEGORY_CREATED
"""A category is updated."""
CATEGORY_UPDATED
"""A category is deleted."""
CATEGORY_DELETED
"""A new channel created."""
CHANNEL_CREATED
"""A channel is updated."""
CHANNEL_UPDATED
"""A channel is deleted."""
CHANNEL_DELETED
"""A channel status is changed."""
CHANNEL_STATUS_CHANGED
"""A new gift card created."""
GIFT_CARD_CREATED
"""A gift card is updated."""
GIFT_CARD_UPDATED
"""A gift card is deleted."""
GIFT_CARD_DELETED
"""A gift card status is changed."""
GIFT_CARD_STATUS_CHANGED
"""
A gift card metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
GIFT_CARD_METADATA_UPDATED
"""A new menu created."""
MENU_CREATED
"""A menu is updated."""
MENU_UPDATED
"""A menu is deleted."""
MENU_DELETED
"""A new menu item created."""
MENU_ITEM_CREATED
"""A menu item is updated."""
MENU_ITEM_UPDATED
"""A menu item is deleted."""
MENU_ITEM_DELETED
"""A new order is placed."""
ORDER_CREATED
"""
An order is confirmed (status change unconfirmed -> unfulfilled) by a staff user using the OrderConfirm mutation. It also triggers when the user completes the checkout and the shop setting `automatically_confirm_all_new_orders` is enabled.
"""
ORDER_CONFIRMED
"""Payment is made and an order is fully paid."""
ORDER_FULLY_PAID
"""
An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED.
"""
ORDER_UPDATED
"""An order is cancelled."""
ORDER_CANCELLED
"""An order is fulfilled."""
ORDER_FULFILLED
"""
An order metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
ORDER_METADATA_UPDATED
"""A draft order is created."""
DRAFT_ORDER_CREATED
"""A draft order is updated."""
DRAFT_ORDER_UPDATED
"""A draft order is deleted."""
DRAFT_ORDER_DELETED
"""A sale is created."""
SALE_CREATED
"""A sale is updated."""
SALE_UPDATED
"""A sale is deleted."""
SALE_DELETED
"""A sale is activated or deactivated."""
SALE_TOGGLE
"""An invoice for order requested."""
INVOICE_REQUESTED
"""An invoice is deleted."""
INVOICE_DELETED
"""Invoice has been sent."""
INVOICE_SENT
"""A new customer account is created."""
CUSTOMER_CREATED
"""A customer account is updated."""
CUSTOMER_UPDATED
"""A customer account is deleted."""
CUSTOMER_DELETED
"""
A customer account metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
CUSTOMER_METADATA_UPDATED
"""A new collection is created."""
COLLECTION_CREATED
"""A collection is updated."""
COLLECTION_UPDATED
"""A collection is deleted."""
COLLECTION_DELETED
"""
A collection metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
COLLECTION_METADATA_UPDATED
"""A new product is created."""
PRODUCT_CREATED
"""A product is updated."""
PRODUCT_UPDATED
"""A product is deleted."""
PRODUCT_DELETED
"""
A product metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
PRODUCT_METADATA_UPDATED
"""A new product variant is created."""
PRODUCT_VARIANT_CREATED
"""A product variant is updated."""
PRODUCT_VARIANT_UPDATED
"""A product variant is deleted."""
PRODUCT_VARIANT_DELETED
"""A product variant is out of stock."""
PRODUCT_VARIANT_OUT_OF_STOCK
"""A product variant is back in stock."""
PRODUCT_VARIANT_BACK_IN_STOCK
"""
A product variant metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
PRODUCT_VARIANT_METADATA_UPDATED
"""A new checkout is created."""
CHECKOUT_CREATED
"""
A checkout is updated. It also triggers all updates related to the checkout.
"""
CHECKOUT_UPDATED
"""
A checkout metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
CHECKOUT_METADATA_UPDATED
"""A new fulfillment is created."""
FULFILLMENT_CREATED
"""A fulfillment is cancelled."""
FULFILLMENT_CANCELED
"""A fulfillment is approved."""
FULFILLMENT_APPROVED
"""
A fulfillment metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
FULFILLMENT_METADATA_UPDATED
"""User notification triggered."""
NOTIFY_USER
"""A new page is created."""
PAGE_CREATED
"""A page is updated."""
PAGE_UPDATED
"""A page is deleted."""
PAGE_DELETED
"""A new page type is created."""
PAGE_TYPE_CREATED
"""A page type is updated."""
PAGE_TYPE_UPDATED
"""A page type is deleted."""
PAGE_TYPE_DELETED
"""A new permission group is created."""
PERMISSION_GROUP_CREATED
"""A permission group is updated."""
PERMISSION_GROUP_UPDATED
"""A permission group is deleted."""
PERMISSION_GROUP_DELETED
"""A new shipping price is created."""
SHIPPING_PRICE_CREATED
"""A shipping price is updated."""
SHIPPING_PRICE_UPDATED
"""A shipping price is deleted."""
SHIPPING_PRICE_DELETED
"""A new shipping zone is created."""
SHIPPING_ZONE_CREATED
"""A shipping zone is updated."""
SHIPPING_ZONE_UPDATED
"""A shipping zone is deleted."""
SHIPPING_ZONE_DELETED
"""
A shipping zone metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
SHIPPING_ZONE_METADATA_UPDATED
"""A new staff user is created."""
STAFF_CREATED
"""A staff user is updated."""
STAFF_UPDATED
"""A staff user is deleted."""
STAFF_DELETED
"""An action requested for transaction."""
TRANSACTION_ACTION_REQUEST
"""
Transaction item metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
TRANSACTION_ITEM_METADATA_UPDATED
"""A new translation is created."""
TRANSLATION_CREATED
"""A translation is updated."""
TRANSLATION_UPDATED
"""A new warehouse created."""
WAREHOUSE_CREATED
"""A warehouse is updated."""
WAREHOUSE_UPDATED
"""A warehouse is deleted."""
WAREHOUSE_DELETED
"""
A warehouse metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
WAREHOUSE_METADATA_UPDATED
"""A new voucher created."""
VOUCHER_CREATED
"""A voucher is updated."""
VOUCHER_UPDATED
"""A voucher is deleted."""
VOUCHER_DELETED
"""
A voucher metadata is updated.
Added in Saleor 3.8.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
VOUCHER_METADATA_UPDATED
"""An observability event is created."""
OBSERVABILITY
"""Authorize payment."""
PAYMENT_AUTHORIZE
"""Capture payment."""
PAYMENT_CAPTURE
"""Confirm payment."""
PAYMENT_CONFIRM
"""Listing available payment gateways."""
PAYMENT_LIST_GATEWAYS
"""Process payment."""
PAYMENT_PROCESS
"""Refund payment."""
PAYMENT_REFUND
"""Void payment."""
PAYMENT_VOID
"""
Event called for checkout tax calculation.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
CHECKOUT_CALCULATE_TAXES
"""
Event called for order tax calculation.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
ORDER_CALCULATE_TAXES
"""Fetch external shipping methods for checkout."""
SHIPPING_LIST_METHODS_FOR_CHECKOUT
"""Filter shipping methods for order."""
ORDER_FILTER_SHIPPING_METHODS
"""Filter shipping methods for checkout."""
CHECKOUT_FILTER_SHIPPING_METHODS
}
"""Enum determining type of webhook."""
enum WebhookEventTypeSyncEnum {
"""Authorize payment."""
PAYMENT_AUTHORIZE
"""Capture payment."""
PAYMENT_CAPTURE
"""Confirm payment."""
PAYMENT_CONFIRM
"""Listing available payment gateways."""
PAYMENT_LIST_GATEWAYS
"""Process payment."""
PAYMENT_PROCESS
"""Refund payment."""
PAYMENT_REFUND
"""Void payment."""
PAYMENT_VOID
"""
Event called for checkout tax calculation.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
CHECKOUT_CALCULATE_TAXES
"""
Event called for order tax calculation.
Added in Saleor 3.6.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
ORDER_CALCULATE_TAXES
"""Fetch external shipping methods for checkout."""
SHIPPING_LIST_METHODS_FOR_CHECKOUT
"""Filter shipping methods for order."""
ORDER_FILTER_SHIPPING_METHODS
"""Filter shipping methods for checkout."""
CHECKOUT_FILTER_SHIPPING_METHODS
}
"""An enumeration."""
enum WebhookSampleEventTypeEnum {
ADDRESS_CREATED
ADDRESS_UPDATED
ADDRESS_DELETED
APP_INSTALLED
APP_UPDATED
APP_DELETED
APP_STATUS_CHANGED
ATTRIBUTE_CREATED
ATTRIBUTE_UPDATED
ATTRIBUTE_DELETED
ATTRIBUTE_VALUE_CREATED
ATTRIBUTE_VALUE_UPDATED
ATTRIBUTE_VALUE_DELETED
CATEGORY_CREATED
CATEGORY_UPDATED
CATEGORY_DELETED
CHANNEL_CREATED
CHANNEL_UPDATED
CHANNEL_DELETED
CHANNEL_STATUS_CHANGED
GIFT_CARD_CREATED
GIFT_CARD_UPDATED
GIFT_CARD_DELETED
GIFT_CARD_STATUS_CHANGED
GIFT_CARD_METADATA_UPDATED
MENU_CREATED
MENU_UPDATED
MENU_DELETED
MENU_ITEM_CREATED
MENU_ITEM_UPDATED
MENU_ITEM_DELETED
ORDER_CREATED
ORDER_CONFIRMED
ORDER_FULLY_PAID
ORDER_UPDATED
ORDER_CANCELLED
ORDER_FULFILLED
ORDER_METADATA_UPDATED
DRAFT_ORDER_CREATED
DRAFT_ORDER_UPDATED
DRAFT_ORDER_DELETED
SALE_CREATED
SALE_UPDATED
SALE_DELETED
SALE_TOGGLE
INVOICE_REQUESTED
INVOICE_DELETED
INVOICE_SENT
CUSTOMER_CREATED
CUSTOMER_UPDATED
CUSTOMER_DELETED
CUSTOMER_METADATA_UPDATED
COLLECTION_CREATED
COLLECTION_UPDATED
COLLECTION_DELETED
COLLECTION_METADATA_UPDATED
PRODUCT_CREATED
PRODUCT_UPDATED
PRODUCT_DELETED
PRODUCT_METADATA_UPDATED
PRODUCT_VARIANT_CREATED
PRODUCT_VARIANT_UPDATED
PRODUCT_VARIANT_DELETED
PRODUCT_VARIANT_OUT_OF_STOCK
PRODUCT_VARIANT_BACK_IN_STOCK
PRODUCT_VARIANT_METADATA_UPDATED
CHECKOUT_CREATED
CHECKOUT_UPDATED
CHECKOUT_METADATA_UPDATED
FULFILLMENT_CREATED
FULFILLMENT_CANCELED
FULFILLMENT_APPROVED
FULFILLMENT_METADATA_UPDATED
NOTIFY_USER
PAGE_CREATED
PAGE_UPDATED
PAGE_DELETED
PAGE_TYPE_CREATED
PAGE_TYPE_UPDATED
PAGE_TYPE_DELETED
PERMISSION_GROUP_CREATED
PERMISSION_GROUP_UPDATED
PERMISSION_GROUP_DELETED
SHIPPING_PRICE_CREATED
SHIPPING_PRICE_UPDATED
SHIPPING_PRICE_DELETED
SHIPPING_ZONE_CREATED
SHIPPING_ZONE_UPDATED
SHIPPING_ZONE_DELETED
SHIPPING_ZONE_METADATA_UPDATED
STAFF_CREATED
STAFF_UPDATED
STAFF_DELETED
TRANSACTION_ACTION_REQUEST
TRANSACTION_ITEM_METADATA_UPDATED
TRANSLATION_CREATED
TRANSLATION_UPDATED
WAREHOUSE_CREATED
WAREHOUSE_UPDATED
WAREHOUSE_DELETED
WAREHOUSE_METADATA_UPDATED
VOUCHER_CREATED
VOUCHER_UPDATED
VOUCHER_DELETED
VOUCHER_METADATA_UPDATED
OBSERVABILITY
}
"""
Updates a webhook subscription.
Requires one of the following permissions: MANAGE_APPS.
"""
type WebhookUpdate {
webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [WebhookError!]!
webhook: Webhook
}
input WebhookUpdateInput {
"""The new name of the webhook."""
name: String
"""The url to receive the payload."""
targetUrl: String
"""
The events that webhook wants to subscribe.
DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead.
"""
events: [WebhookEventTypeEnum!]
"""The asynchronous events that webhook wants to subscribe."""
asyncEvents: [WebhookEventTypeAsyncEnum!]
"""The synchronous events that webhook wants to subscribe."""
syncEvents: [WebhookEventTypeSyncEnum!]
"""ID of the app to which webhook belongs."""
app: ID
"""Determine if webhook will be set active or not."""
isActive: Boolean
"""
Use to create a hash signature with each payload.
DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.
"""
secretKey: String
"""
Subscription query used to define a webhook payload.
Added in Saleor 3.2.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
query: String
}
"""Represents weight value in a specific weight unit."""
type Weight {
"""Weight unit."""
unit: WeightUnitsEnum!
"""Weight value."""
value: Float!
}
scalar WeightScalar
"""An enumeration."""
enum WeightUnitsEnum {
G
LB
OZ
KG
TONNE
}
"""_Any value scalar as defined by Federation spec."""
scalar _Any
"""_Entity union as defined by Federation spec."""
union _Entity = App | Address | User | Group | ProductVariant | Product | ProductType | Collection | Category | ProductMedia | PageType
"""_Service manifest as defined by Federation spec."""
type _Service {
sdl: String
}