diff --git a/apps/orders-export/.env.example b/apps/orders-export/.env.example new file mode 100644 index 0000000..c829359 --- /dev/null +++ b/apps/orders-export/.env.example @@ -0,0 +1,18 @@ +# The key used for metadata encryption. Required for production builds +SECRET_KEY= + +# APL Config +# https://github.com/saleor/saleor-app-sdk/blob/main/docs/apl.md +APL=file +REST_APL_ENDPOINT= +REST_APL_TOKEN= + +APP_LOG_LEVEL=info + +# Local development variables. When developped locally with Saleor inside docker, these can be set to: +# APP_IFRAME_BASE_URL = http://localhost:3000, so Dashboard on host can access iframe +# APP_API_BASE_URL=http://host.docker.internal:3000 - so Saleor can reach App running on host, from the container. +# If developped with tunnels, set this empty, it will fallback to default Next's localhost:3000 +# https://docs.saleor.io/docs/3.x/developer/extending/apps/local-app-development +APP_IFRAME_BASE_URL= +APP_API_BASE_URL= \ No newline at end of file diff --git a/apps/orders-export/.eslintrc.json b/apps/orders-export/.eslintrc.json new file mode 100644 index 0000000..5470783 --- /dev/null +++ b/apps/orders-export/.eslintrc.json @@ -0,0 +1,4 @@ +{ + "root": true, + "extends": ["saleor"] +} diff --git a/apps/orders-export/.graphqlrc.yml b/apps/orders-export/.graphqlrc.yml new file mode 100644 index 0000000..b0db306 --- /dev/null +++ b/apps/orders-export/.graphqlrc.yml @@ -0,0 +1,19 @@ +schema: graphql/schema.graphql +documents: [graphql/**/*.graphql, src/**/*.ts, src/**/*.tsx] +extensions: + codegen: + overwrite: true + generates: + generated/graphql.ts: + config: + dedupeFragments: true + plugins: + - typescript + - typescript-operations + - typescript-urql: + documentVariablePrefix: "Untyped" + fragmentVariablePrefix: "Untyped" + - typed-document-node + generated/schema.graphql: + plugins: + - schema-ast diff --git a/apps/orders-export/graphql/fragments/order-base.graphql b/apps/orders-export/graphql/fragments/order-base.graphql new file mode 100644 index 0000000..acb356b --- /dev/null +++ b/apps/orders-export/graphql/fragments/order-base.graphql @@ -0,0 +1,31 @@ +fragment OrderBase on Order { + id + user { + id + email + } + channel { + id + slug + name + } + userEmail + shippingMethodName + total { + gross { + amount + currency + } + net { + currency + amount + } + } + lines { + id + productVariantId + productSku + variantName + } + number +} diff --git a/apps/orders-export/graphql/mutations/UpdateAppMetadata.graphql b/apps/orders-export/graphql/mutations/UpdateAppMetadata.graphql new file mode 100644 index 0000000..718ec63 --- /dev/null +++ b/apps/orders-export/graphql/mutations/UpdateAppMetadata.graphql @@ -0,0 +1,10 @@ +mutation UpdateAppMetadata($id: ID!, $input: [MetadataInput!]!) { + updatePrivateMetadata(id: $id, input: $input) { + item { + privateMetadata { + key + value + } + } + } +} diff --git a/apps/orders-export/graphql/schema.graphql b/apps/orders-export/graphql/schema.graphql new file mode 100644 index 0000000..9a3320b --- /dev/null +++ b/apps/orders-export/graphql/schema.graphql @@ -0,0 +1,30308 @@ +schema { + query: Query + mutation: Mutation + subscription: Subscription +} + +"""Groups fields and operations into named groups.""" +directive @doc( + """Name of the grouping category""" + category: String! +) on ENUM | FIELD | FIELD_DEFINITION | INPUT_OBJECT | OBJECT + +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 @doc(category: "Webhooks") + + """ + List of all available webhook events. + + Requires one of the following permissions: MANAGE_APPS. + """ + webhookEvents: [WebhookEvent!] @doc(category: "Webhooks") @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 @doc(category: "Webhooks") + + """ + Look up a warehouse by ID. + + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS, MANAGE_SHIPPING. + """ + warehouse( + """ID of a warehouse.""" + id: ID + + """ + External ID of a warehouse. + + Added in Saleor 3.10. + """ + externalReference: String + ): Warehouse @doc(category: "Products") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): WarehouseCountableConnection @doc(category: "Products") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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. + + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. + """ + taxConfiguration( + """ID of a tax configuration.""" + id: ID! + ): TaxConfiguration @doc(category: "Taxes") + + """ + List of tax configurations. + + Added in Saleor 3.9. + + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): TaxConfigurationCountableConnection @doc(category: "Taxes") + + """ + Look up a tax class. + + Added in Saleor 3.9. + + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. + """ + taxClass( + """ID of a tax class.""" + id: ID! + ): TaxClass @doc(category: "Taxes") + + """ + List of tax classes. + + Added in Saleor 3.9. + + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): TaxClassCountableConnection @doc(category: "Taxes") + + """ + 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 @doc(category: "Taxes") + + "\\n\\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP." + taxCountryConfigurations: [TaxCountryConfiguration!] @doc(category: "Taxes") + + """ + Look up a stock by ID + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + stock( + """ID of an warehouse""" + id: ID! + ): Stock @doc(category: "Products") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): StockCountableConnection @doc(category: "Products") + + """Return information about the shop.""" + shop: Shop! + + """ + Order related settings from site settings. Returns `orderSettings` for the first `channel` in alphabetical order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderSettings: OrderSettings @doc(category: "Orders") @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `channel` query to fetch the `orderSettings` field instead.") + + """ + Gift card related settings from site settings. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardSettings: GiftCardSettings! @doc(category: "Gift cards") + + """ + 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 @doc(category: "Shipping") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ShippingZoneCountableConnection @doc(category: "Shipping") + + """ + Look up digital content by ID. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + digitalContent( + """ID of the digital content.""" + id: ID! + ): DigitalContent @doc(category: "Products") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): DigitalContentCountableConnection @doc(category: "Products") + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): CategoryCountableConnection @doc(category: "Products") + + """Look up a category by ID or slug.""" + category( + """ID of the category.""" + id: ID + + """Slug of the category""" + slug: String + ): Category @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): CollectionCountableConnection @doc(category: "Products") + + """ + 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 + + """ + External ID of the product. + + Added in Saleor 3.10. + """ + externalReference: String + + """Slug of a channel for which the data should be returned.""" + channel: String + ): Product @doc(category: "Products") + + """ + 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 + + """ + Where filtering options. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + where: ProductWhereInput + + """Sort products.""" + sortBy: ProductOrder + + """ + Search products. + + Added in Saleor 3.14. + """ + search: 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ProductCountableConnection @doc(category: "Products") + + """Look up a product type by ID.""" + productType( + """ID of the product type.""" + id: ID! + ): ProductType @doc(category: "Products") + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ProductTypeCountableConnection @doc(category: "Products") + + """ + 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 + + """ + External ID of the product. + + Added in Saleor 3.10. + """ + externalReference: String + + """Slug of a channel for which the data should be returned.""" + channel: String + ): ProductVariant @doc(category: "Products") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ProductVariantCountableConnection @doc(category: "Products") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ProductVariantCountableConnection @doc(category: "Products") + + """ + Look up a payment by ID. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + payment( + """ID of the payment.""" + id: ID! + ): Payment @doc(category: "Payments") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): PaymentCountableConnection @doc(category: "Payments") + + """ + 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 @doc(category: "Payments") + + """Look up a page by ID or slug.""" + page( + """ID of the page.""" + id: ID + + """The slug of the page.""" + slug: String + ): Page @doc(category: "Pages") + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): PageCountableConnection @doc(category: "Pages") + + """Look up a page type by ID.""" + pageType( + """ID of the page type.""" + id: ID! + ): PageType @doc(category: "Pages") + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): PageTypeCountableConnection @doc(category: "Pages") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): OrderEventCountableConnection @doc(category: "Orders") + + """Look up an order by ID or external reference.""" + order( + """ID of an order.""" + id: ID + + """ + External ID of an order. + + Added in Saleor 3.10. + """ + externalReference: String + ): Order @doc(category: "Orders") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): OrderCountableConnection @doc(category: "Orders") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): OrderCountableConnection @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """Look up an order by token.""" + orderByToken( + """The order's token.""" + token: UUID! + ): Order @doc(category: "Orders") @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 @doc(category: "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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): MenuCountableConnection @doc(category: "Menu") + + """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 @doc(category: "Menu") + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): MenuItemCountableConnection @doc(category: "Menu") + + """ + 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 @doc(category: "Gift cards") + + """ + List of gift cards. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCards( + """ + Sort gift cards. + + Added in Saleor 3.1. + """ + sortBy: GiftCardSortingInput + + """ + Filtering options for gift cards. + + Added in Saleor 3.1. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): GiftCardCountableConnection @doc(category: "Gift cards") + + """ + List of gift card currencies. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardCurrencies: [String!]! @doc(category: "Gift cards") + + """ + List of gift card tags. + + Added in Saleor 3.1. + + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): GiftCardTagCountableConnection @doc(category: "Gift cards") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 @doc(category: "Discounts") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): SaleCountableConnection @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): VoucherCountableConnection @doc(category: "Discounts") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ExportFileCountableConnection + + """List of all tax rates available from tax gateway.""" + taxTypes: [TaxType!] @doc(category: "Taxes") + + """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 @doc(category: "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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): CheckoutCountableConnection @doc(category: "Checkout") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): CheckoutLineCountableConnection @doc(category: "Checkout") + + """Look up a channel by ID or slug.""" + channel( + """ID of the channel.""" + id: ID + + """ + Slug of the channel. + + Added in Saleor 3.6. + """ + slug: String + ): Channel @doc(category: "Channels") + + """ + List of all channels. + + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. + """ + channels: [Channel!] @doc(category: "Channels") + + """List of the shop's attributes.""" + attributes( + """Filtering options for attributes.""" + filter: AttributeFilterInput + + """ + Filtering options for attributes. + + Added in Saleor 3.11. + """ + where: AttributeWhereInput + + """ + Search attributes. + + Added in Saleor 3.11. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + search: String + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): AttributeCountableConnection @doc(category: "Attributes") + + """Look up an attribute by ID, slug or external reference.""" + attribute( + """ID of the attribute.""" + id: ID + + """Slug of the attribute.""" + slug: String + + """ + External ID of the attribute. + + Added in Saleor 3.10. + """ + externalReference: String + ): Attribute @doc(category: "Attributes") + + """ + List of all apps installations + + Requires one of the following permissions: MANAGE_APPS. + """ + appsInstallations: [AppInstallation!]! @doc(category: "Apps") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): AppCountableConnection @doc(category: "Apps") + + """ + 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 @doc(category: "Apps") + + """ + List of all extensions. + + Added in Saleor 3.1. + + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): AppExtensionCountableConnection @doc(category: "Apps") + + """ + Look up an app extension by ID. + + Added in Saleor 3.1. + + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. + """ + appExtension( + """ID of the app extension.""" + id: ID! + ): AppExtension @doc(category: "Apps") + + """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 @doc(category: "Users") + + """ + Look up an address by ID. + + Requires one of the following permissions: MANAGE_USERS, OWNER. + """ + address( + """ID of an address.""" + id: ID! + ): Address @doc(category: "Users") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): UserCountableConnection @doc(category: "Users") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): GroupCountableConnection @doc(category: "Users") + + """ + Look up permission group by ID. + + Requires one of the following permissions: MANAGE_STAFF. + """ + permissionGroup( + """ID of the group.""" + id: ID! + ): Group @doc(category: "Users") + + """Return the currently authenticated user.""" + me: User @doc(category: "Users") + + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): UserCountableConnection @doc(category: "Users") + + """ + 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 + + """ + External ID of the user. + + Added in Saleor 3.10. + """ + externalReference: String + ): User @doc(category: "Users") + _entities(representations: [_Any]): [_Entity] + _service: _Service +} + +"""Webhook.""" +type Webhook implements Node @doc(category: "Webhooks") { + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Custom headers, which will be added to HTTP request. + + Added in Saleor 3.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + customHeaders: JSONString +} + +"""An object with an ID""" +interface Node { + """The ID of the object.""" + id: ID! +} + +"""Webhook event.""" +type WebhookEvent @doc(category: "Webhooks") { + """Display name of the event.""" + name: String! + + """Internal name of the event type.""" + eventType: WebhookEventTypeEnum! +} + +"""Enum determining type of webhook.""" +enum WebhookEventTypeEnum @doc(category: "Webhooks") { + """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 has been sent. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + GIFT_CARD_SENT + + """A gift card status is changed.""" + GIFT_CARD_STATUS_CHANGED + + """ + A gift card metadata is updated. + + Added in Saleor 3.8. + """ + 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 has been made. The order may be partially or fully paid. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_PAID + + """Payment is made and an order is fully paid.""" + ORDER_FULLY_PAID + + """ + The order received a refund. The order may be partially or fully refunded. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_REFUNDED + + """ + The order is fully refunded. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_FULLY_REFUNDED + + """ + 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 expired.""" + ORDER_EXPIRED + + """An order is fulfilled.""" + ORDER_FULFILLED + + """ + An order metadata is updated. + + Added in Saleor 3.8. + """ + ORDER_METADATA_UPDATED + + """ + Orders are imported. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_BULK_CREATED + + """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. + """ + 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. + """ + COLLECTION_METADATA_UPDATED + + """A new product is created.""" + PRODUCT_CREATED + + """A product is updated.""" + PRODUCT_UPDATED + + """A product is deleted.""" + PRODUCT_DELETED + + """ + A new product media is created. + + Added in Saleor 3.12. + """ + PRODUCT_MEDIA_CREATED + + """ + A product media is updated. + + Added in Saleor 3.12. + """ + PRODUCT_MEDIA_UPDATED + + """ + A product media is deleted. + + Added in Saleor 3.12. + """ + PRODUCT_MEDIA_DELETED + + """ + A product metadata is updated. + + Added in Saleor 3.8. + """ + 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 stock is updated""" + PRODUCT_VARIANT_STOCK_UPDATED + + """ + A product variant metadata is updated. + + Added in Saleor 3.8. + """ + 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 + CHECKOUT_FULLY_PAID + + """ + A checkout metadata is updated. + + Added in Saleor 3.8. + """ + 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. + """ + 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. + """ + 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. + + DEPRECATED: this subscription will be removed in Saleor 3.14 (Preview Feature). Use `TRANSACTION_CHARGE_REQUESTED`, `TRANSACTION_REFUND_REQUESTED`, `TRANSACTION_CANCELATION_REQUESTED` instead. + """ + TRANSACTION_ACTION_REQUEST + + """ + Transaction item metadata is updated. + + Added in Saleor 3.8. + """ + 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. + """ + 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. + """ + VOUCHER_METADATA_UPDATED + + """An observability event is created.""" + OBSERVABILITY + + """ + A thumbnail is created. + + Added in Saleor 3.12. + """ + THUMBNAIL_CREATED + + """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 when charge has been requested for transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + TRANSACTION_CHARGE_REQUESTED + + """ + Event called when refund has been requested for transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + TRANSACTION_REFUND_REQUESTED + + """ + Event called when cancel has been requested for transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + TRANSACTION_CANCELATION_REQUESTED + + """ + Event called for checkout tax calculation. + + Added in Saleor 3.6. + """ + CHECKOUT_CALCULATE_TAXES + + """ + Event called for order tax calculation. + + Added in Saleor 3.6. + """ + 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 + PAYMENT_GATEWAY_INITIALIZE_SESSION + TRANSACTION_INITIALIZE_SESSION + TRANSACTION_PROCESS_SESSION +} + +"""Synchronous webhook event.""" +type WebhookEventSync @doc(category: "Webhooks") { + """Display name of the event.""" + name: String! + + """Internal name of the event type.""" + eventType: WebhookEventTypeSyncEnum! +} + +"""Enum determining type of webhook.""" +enum WebhookEventTypeSyncEnum @doc(category: "Webhooks") { + """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 when charge has been requested for transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + TRANSACTION_CHARGE_REQUESTED + + """ + Event called when refund has been requested for transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + TRANSACTION_REFUND_REQUESTED + + """ + Event called when cancel has been requested for transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + TRANSACTION_CANCELATION_REQUESTED + + """ + Event called for checkout tax calculation. + + Added in Saleor 3.6. + """ + CHECKOUT_CALCULATE_TAXES + + """ + Event called for order tax calculation. + + Added in Saleor 3.6. + """ + 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 + PAYMENT_GATEWAY_INITIALIZE_SESSION + TRANSACTION_INITIALIZE_SESSION + TRANSACTION_PROCESS_SESSION +} + +"""Asynchronous webhook event.""" +type WebhookEventAsync @doc(category: "Webhooks") { + """Display name of the event.""" + name: String! + + """Internal name of the event type.""" + eventType: WebhookEventTypeAsyncEnum! +} + +"""Enum determining type of webhook.""" +enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { + """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 has been sent. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + GIFT_CARD_SENT + + """A gift card status is changed.""" + GIFT_CARD_STATUS_CHANGED + + """ + A gift card metadata is updated. + + Added in Saleor 3.8. + """ + 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 has been made. The order may be partially or fully paid. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_PAID + + """Payment is made and an order is fully paid.""" + ORDER_FULLY_PAID + + """ + The order received a refund. The order may be partially or fully refunded. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_REFUNDED + + """ + The order is fully refunded. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_FULLY_REFUNDED + + """ + 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 expired.""" + ORDER_EXPIRED + + """An order is fulfilled.""" + ORDER_FULFILLED + + """ + An order metadata is updated. + + Added in Saleor 3.8. + """ + ORDER_METADATA_UPDATED + + """ + Orders are imported. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + ORDER_BULK_CREATED + + """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. + """ + 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. + """ + COLLECTION_METADATA_UPDATED + + """A new product is created.""" + PRODUCT_CREATED + + """A product is updated.""" + PRODUCT_UPDATED + + """A product is deleted.""" + PRODUCT_DELETED + + """ + A new product media is created. + + Added in Saleor 3.12. + """ + PRODUCT_MEDIA_CREATED + + """ + A product media is updated. + + Added in Saleor 3.12. + """ + PRODUCT_MEDIA_UPDATED + + """ + A product media is deleted. + + Added in Saleor 3.12. + """ + PRODUCT_MEDIA_DELETED + + """ + A product metadata is updated. + + Added in Saleor 3.8. + """ + 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 stock is updated""" + PRODUCT_VARIANT_STOCK_UPDATED + + """ + A product variant metadata is updated. + + Added in Saleor 3.8. + """ + 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 + CHECKOUT_FULLY_PAID + + """ + A checkout metadata is updated. + + Added in Saleor 3.8. + """ + 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. + """ + 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. + """ + 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. + + DEPRECATED: this subscription will be removed in Saleor 3.14 (Preview Feature). Use `TRANSACTION_CHARGE_REQUESTED`, `TRANSACTION_REFUND_REQUESTED`, `TRANSACTION_CANCELATION_REQUESTED` instead. + """ + TRANSACTION_ACTION_REQUEST + + """ + Transaction item metadata is updated. + + Added in Saleor 3.8. + """ + 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. + """ + 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. + """ + VOUCHER_METADATA_UPDATED + + """An observability event is created.""" + OBSERVABILITY + + """ + A thumbnail is created. + + Added in Saleor 3.12. + """ + THUMBNAIL_CREATED +} + +"""Represents app data.""" +type App implements Node & ObjectWithMetadata @doc(category: "Apps") { + 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 + + """ + The App's author name. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + author: String + + """ + App's dashboard extensions. + + Added in Saleor 3.1. + """ + extensions: [AppExtension!]! + + """ + App's brand data. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + brand: AppBrand +} + +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. + """ + 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. + """ + 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. + """ + metafield(key: String!): String + + """ + Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. + """ + metafields(keys: [String!]): Metadata +} + +type MetadataItem { + """Key of a metadata item.""" + key: String! + + """Value of a metadata item.""" + value: String! +} + +""" +Metadata is a map of key-value pairs, both keys and values are `String`. + +Example: +``` +{ + "key1": "value1", + "key2": "value2" +} +``` +""" +scalar Metadata + +"""Represents a permission object in a friendly form.""" +type Permission @doc(category: "Authentication") { + """Internal code for permission.""" + code: PermissionEnum! + + """Describe action(s) allowed to do by permission.""" + name: String! +} + +"""An enumeration.""" +enum PermissionEnum @doc(category: "Users") { + MANAGE_USERS + MANAGE_STAFF + IMPERSONATE_USER + MANAGE_APPS + MANAGE_OBSERVABILITY + MANAGE_CHECKOUTS + HANDLE_CHECKOUTS + HANDLE_TAXES + MANAGE_TAXES + MANAGE_CHANNELS + MANAGE_DISCOUNTS + MANAGE_GIFT_CARD + MANAGE_MENUS + MANAGE_ORDERS + MANAGE_ORDERS_IMPORT + MANAGE_PAGES + MANAGE_PAGE_TYPES_AND_ATTRIBUTES + HANDLE_PAYMENTS + MANAGE_PLUGINS + MANAGE_PRODUCTS + MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES + MANAGE_SHIPPING + MANAGE_SETTINGS + MANAGE_TRANSLATIONS +} + +""" +The `DateTime` scalar type represents a DateTime +value as specified by +[iso8601](https://en.wikipedia.org/wiki/ISO_8601). +""" +scalar DateTime + +"""Enum determining type of your App.""" +enum AppTypeEnum @doc(category: "Apps") { + """ + 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 +} + +"""Represents token data.""" +type AppToken implements Node @doc(category: "Apps") { + id: ID! + + """Name of the authenticated token.""" + name: String + + """Last 4 characters of the token.""" + authToken: String +} + +"""Represents app data.""" +type AppExtension implements Node @doc(category: "Apps") { + 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 +} + +"""All places where app extension can be mounted.""" +enum AppExtensionMountEnum @doc(category: "Apps") { + 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 @doc(category: "Apps") { + POPUP + APP_PAGE +} + +""" +Represents the app's brand data. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type AppBrand @doc(category: "Apps") { + """ + App's logos details. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + logo: AppBrandLogo! +} + +""" +Represents the app's brand logo data. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type AppBrandLogo @doc(category: "Apps") { + """ + URL to the default logo image. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + default( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + format: IconThumbnailFormatEnum = ORIGINAL + ): String! +} + +"""Thumbnail formats for icon images.""" +enum IconThumbnailFormatEnum { + ORIGINAL + WEBP +} + +type EventDeliveryCountableConnection { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [EventDeliveryCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +""" +The Relay compliant `PageInfo` type, containing data necessary to paginate this connection. +""" +type PageInfo { + """When paginating forwards, are there more items?""" + hasNextPage: Boolean! + + """When paginating backwards, are there more items?""" + hasPreviousPage: Boolean! + + """When paginating backwards, the cursor to continue.""" + startCursor: String + + """When paginating forwards, the cursor to continue.""" + endCursor: String +} + +type EventDeliveryCountableEdge { + """The item at the end of the edge.""" + node: EventDelivery! + + """A cursor for use in pagination.""" + cursor: String! +} + +"""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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): EventDeliveryAttemptCountableConnection + + """Event payload.""" + payload: String +} + +enum EventDeliveryStatusEnum @doc(category: "Webhooks") { + PENDING + SUCCESS + FAILED +} + +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! +} + +"""Event delivery attempts.""" +type EventDeliveryAttempt implements Node @doc(category: "Webhooks") { + 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! +} + +input EventDeliveryAttemptSortingInput @doc(category: "Webhooks") { + """Specifies the direction in which to sort attempts.""" + direction: OrderDirection! + + """Sort attempts by the selected field.""" + field: EventDeliveryAttemptSortField! +} + +enum OrderDirection { + """Specifies an ascending sort order.""" + ASC + + """Specifies a descending sort order.""" + DESC +} + +enum EventDeliveryAttemptSortField @doc(category: "Webhooks") { + """Sort event delivery attempts by created at.""" + CREATED_AT +} + +input EventDeliverySortingInput @doc(category: "Webhooks") { + """Specifies the direction in which to sort deliveries.""" + direction: OrderDirection! + + """Sort deliveries by the selected field.""" + field: EventDeliverySortField! +} + +enum EventDeliverySortField @doc(category: "Webhooks") { + """Sort event deliveries by created at.""" + CREATED_AT +} + +input EventDeliveryFilterInput { + status: EventDeliveryStatusEnum + eventType: WebhookEventTypeEnum +} + +scalar JSONString + +"""An enumeration.""" +enum WebhookSampleEventTypeEnum @doc(category: "Webhooks") { + 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_SENT + 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_PAID + ORDER_FULLY_PAID + ORDER_REFUNDED + ORDER_FULLY_REFUNDED + ORDER_UPDATED + ORDER_CANCELLED + ORDER_EXPIRED + ORDER_FULFILLED + ORDER_METADATA_UPDATED + ORDER_BULK_CREATED + 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_MEDIA_CREATED + PRODUCT_MEDIA_UPDATED + PRODUCT_MEDIA_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_STOCK_UPDATED + PRODUCT_VARIANT_METADATA_UPDATED + CHECKOUT_CREATED + CHECKOUT_UPDATED + CHECKOUT_FULLY_PAID + 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 + THUMBNAIL_CREATED +} + +"""Represents warehouse.""" +type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") { + 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. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ShippingZoneCountableConnection! + + """ + External ID of this warehouse. + + Added in Saleor 3.10. + """ + externalReference: String +} + +"""Represents user address data.""" +type Address implements Node & ObjectWithMetadata @doc(category: "Users") { + id: ID! + + """ + List of private metadata items. Requires staff permissions to access. + + Added in Saleor 3.10. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + 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.10. + + 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.10. + + 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. + + Added in Saleor 3.10. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + metadata: [MetadataItem!]! + + """ + A single key from public metadata. + + Tip: Use GraphQL aliases to fetch multiple keys. + + Added in Saleor 3.10. + + 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.10. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + metafields(keys: [String!]): Metadata + firstName: String! + lastName: String! + companyName: String! + streetAddress1: String! + streetAddress2: String! + city: String! + cityArea: String! + postalCode: String! + + """Shop's default country.""" + country: CountryDisplay! + countryArea: String! + phone: String + + """Address is user's default shipping address.""" + isDefaultShippingAddress: Boolean + + """Address is user's default billing address.""" + isDefaultBillingAddress: Boolean +} + +type 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.") +} + +"""Represents a VAT rate for a country.""" +type VAT @doc(category: "Taxes") { + """Country code.""" + countryCode: String! + + """Standard VAT rate in percent.""" + standardRate: Float + + """Country's VAT rate exceptions for specific types of goods.""" + reducedRates: [ReducedRate!]! +} + +"""Represents a reduced VAT rate for a particular type of goods.""" +type ReducedRate @doc(category: "Taxes") { + """Reduced VAT rate in percent.""" + rate: Float! + + """A type of goods.""" + rateType: String! +} + +"""An enumeration.""" +enum WarehouseClickAndCollectOptionEnum @doc(category: "Products") { + DISABLED + LOCAL + ALL +} + +type ShippingZoneCountableConnection @doc(category: "Shipping") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [ShippingZoneCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type ShippingZoneCountableEdge @doc(category: "Shipping") { + """The item at the end of the edge.""" + node: ShippingZone! + + """A cursor for use in pagination.""" + cursor: String! +} + +""" +Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly. +""" +type ShippingZone implements Node & ObjectWithMetadata @doc(category: "Shipping") { + 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 +} + +"""Represents a range of amounts of money.""" +type MoneyRange { + """Lower bound of a price range.""" + start: Money + + """Upper bound of a price range.""" + stop: Money +} + +"""Represents amount of money in specific currency.""" +type Money { + """Currency code.""" + currency: String! + + """Amount of money.""" + amount: Float! +} + +""" +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 @doc(category: "Shipping") { + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. + """ + taxClass: TaxClass +} + +"""An enumeration.""" +enum ShippingMethodTypeEnum @doc(category: "Shipping") { + PRICE + WEIGHT +} + +type ShippingMethodTranslation implements Node @doc(category: "Shipping") { + 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 +} + +type LanguageDisplay { + """ISO 639 representation of the language name.""" + code: LanguageCodeEnum! + + """Full name of the language.""" + language: String! +} + +"""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 +} + +"""Represents shipping method channel listing.""" +type ShippingMethodChannelListing implements Node @doc(category: "Shipping") { + id: ID! + channel: Channel! + maximumOrderPrice: Money + minimumOrderPrice: Money + price: Money +} + +"""Represents channel.""" +type Channel implements Node @doc(category: "Channels") { + 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. + + 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. + """ + countries: [CountryDisplay!] + + """ + Shipping methods that are available for the channel. + + Added in Saleor 3.6. + """ + availableShippingMethodsPerCountry(countries: [CountryCode!]): [ShippingMethodsPerCountry!] + + """ + Define the stock setting for this channel. + + Added in Saleor 3.7. + + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. + """ + stockSettings: StockSettings! + + """ + Channel-specific order settings. + + Added in Saleor 3.12. + + Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_ORDERS. + """ + orderSettings: OrderSettings! +} + +""" +List of shipping methods available for the country. + +Added in Saleor 3.6. +""" +type ShippingMethodsPerCountry @doc(category: "Shipping") { + """The country code.""" + countryCode: CountryCode! + + """List of available shipping methods.""" + shippingMethods: [ShippingMethod!] +} + +"""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 +} + +""" +Shipping methods that can be used as means of shipping for orders and checkouts. +""" +type ShippingMethod implements Node & ObjectWithMetadata @doc(category: "Shipping") { + """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. + """ + 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. + """ + 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. + """ + metafield(key: String!): String + + """ + Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. + """ + 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 weight value in a specific weight unit.""" +type Weight { + """Weight unit.""" + unit: WeightUnitsEnum! + + """Weight value.""" + value: Float! +} + +"""An enumeration.""" +enum WeightUnitsEnum { + G + LB + OZ + KG + TONNE +} + +""" +Represents the channel stock settings. + +Added in Saleor 3.7. +""" +type StockSettings @doc(category: "Products") { + """ + Allocation strategy defines the preference of warehouses for allocations and reservations. + """ + allocationStrategy: AllocationStrategyEnum! +} + +""" +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 @doc(category: "Products") { + PRIORITIZE_SORTING_ORDER + PRIORITIZE_HIGH_STOCK +} + +"""Represents the channel-specific order settings.""" +type OrderSettings { + """ + 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! + + """ + Expiration time in minutes. Default null - means do not expire any orders. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + expireOrdersAfter: Minute + + """ + Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. + `PAYMENT_FLOW` - [default option] creates the `Payment` object. + `TRANSACTION_FLOW` - creates the `TransactionItem` object. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + markAsPaidStrategy: MarkAsPaidStrategyEnum! + + """ + Determine the transaction flow strategy to be used. Include the selected option in the payload sent to the payment app, as a requested action for the transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + defaultTransactionFlowStrategy: TransactionFlowStrategyEnum! + + """ + The time in days after expired orders will be deleted. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + deleteExpiredOrdersAfter: Day! +} + +""" +The `Minute` scalar type represents number of minutes by integer value. +""" +scalar Minute + +""" +Determine the mark as paid strategy for the channel. + + TRANSACTION_FLOW - new orders marked as paid will receive a + `TransactionItem` object, that will cover the `order.total`. + + PAYMENT_FLOW - new orders marked as paid will receive a + `Payment` object, that will cover the `order.total`. +""" +enum MarkAsPaidStrategyEnum @doc(category: "Channels") { + TRANSACTION_FLOW + PAYMENT_FLOW +} + +""" +Determine the transaction flow strategy. + + AUTHORIZATION - the processed transaction should be only authorized + CHARGE - the processed transaction should be charged. +""" +enum TransactionFlowStrategyEnum @doc(category: "Payments") { + AUTHORIZATION + CHARGE +} + +"""The `Day` scalar type represents number of days by integer value.""" +scalar Day + +"""Represents shipping method postal code rule.""" +type ShippingMethodPostalCodeRule implements Node @doc(category: "Shipping") { + """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 +} + +"""An enumeration.""" +enum PostalCodeRuleInclusionTypeEnum @doc(category: "Shipping") { + INCLUDE + EXCLUDE +} + +type ProductCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [ProductCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type ProductCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: Product! + + """A cursor for use in pagination.""" + cursor: String! +} + +"""Represents an individual item for sale in the storefront.""" +type Product implements Node & ObjectWithMetadata @doc(category: "Products") { + 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( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.6. + """ + format: ThumbnailFormatEnum = ORIGINAL + ): 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.") + + """ + Get a single attribute attached to product by attribute slug. + + Added in Saleor 3.9. + """ + attribute( + """Slug of the attribute""" + slug: String! + ): SelectedAttribute + + """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.") + + """ + Get a single variant by SKU or ID. + + Added in Saleor 3.9. + """ + variant( + """ID of the variant.""" + id: ID + + """SKU of the variant.""" + sku: String + ): ProductVariant @deprecated(reason: "This field will be removed in Saleor 4.0. Use top-level `variant` query.") + + """ + 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( + """ + Sort media. + + Added in Saleor 3.9. + """ + sortBy: MediaSortingInput + ): [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, AUTHENTICATED_APP. + """ + taxClass: TaxClass + + """ + External ID of this product. + + Added in Saleor 3.10. + """ + externalReference: String +} + +""" +Represents a type of product. It defines what attributes are available to products of this type. +""" +type ProductType implements Node & ObjectWithMetadata @doc(category: "Products") { + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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, AUTHENTICATED_APP. + """ + 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 + where: AttributeWhereInput + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): AttributeCountableConnection +} + +"""An enumeration.""" +enum ProductTypeKindEnum @doc(category: "Products") { + NORMAL + GIFT_CARD +} + +"""Representation of tax types fetched from tax gateway.""" +type TaxType @doc(category: "Taxes") { + """Description of the tax type.""" + description: String + + """External tax code used to identify given tax group.""" + taxCode: String +} + +""" +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. +""" +type TaxClass implements Node & ObjectWithMetadata @doc(category: "Taxes") { + """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!]! +} + +""" +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. +""" +type TaxClassCountryRate @doc(category: "Taxes") { + """Country in which this tax rate applies.""" + country: CountryDisplay! + + """Tax rate value.""" + rate: Float! + + """Related tax class.""" + taxClass: TaxClass +} + +""" +Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. +""" +type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes") { + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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! @deprecated(reason: "This field will be removed in Saleor 4.0.") + + """ + 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! @deprecated(reason: "This field will be removed in Saleor 4.0.") + + """ + 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! @deprecated(reason: "This field will be removed in Saleor 4.0.") + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ProductTypeCountableConnection! + + """ + External ID of this attribute. + + Added in Saleor 3.10. + """ + externalReference: String +} + +"""An enumeration.""" +enum AttributeInputTypeEnum @doc(category: "Attributes") { + DROPDOWN + MULTISELECT + FILE + REFERENCE + NUMERIC + RICH_TEXT + PLAIN_TEXT + SWATCH + BOOLEAN + DATE + DATE_TIME +} + +"""An enumeration.""" +enum AttributeEntityTypeEnum @doc(category: "Attributes") { + PAGE + PRODUCT + PRODUCT_VARIANT +} + +"""An enumeration.""" +enum AttributeTypeEnum @doc(category: "Attributes") { + PRODUCT_TYPE + PAGE_TYPE +} + +"""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 +} + +type AttributeValueCountableConnection @doc(category: "Attributes") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [AttributeValueCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type AttributeValueCountableEdge @doc(category: "Attributes") { + """The item at the end of the edge.""" + node: AttributeValue! + + """A cursor for use in pagination.""" + cursor: String! +} + +"""Represents a value of an attribute.""" +type AttributeValue implements Node @doc(category: "Attributes") { + 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 + + """ + External ID of this attribute value. + + Added in Saleor 3.10. + """ + externalReference: String +} + +type AttributeValueTranslation implements Node @doc(category: "Attributes") { + 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 +} + +type File { + """The URL of the file.""" + url: String! + + """Content type of the file.""" + contentType: String +} + +""" +The `Date` scalar type represents a Date +value as specified by +[iso8601](https://en.wikipedia.org/wiki/ISO_8601). +""" +scalar Date + +input AttributeChoicesSortingInput @doc(category: "Attributes") { + """Specifies the direction in which to sort attribute choices.""" + direction: OrderDirection! + + """Sort attribute choices by the selected field.""" + field: AttributeChoicesSortField! +} + +enum AttributeChoicesSortField @doc(category: "Attributes") { + """Sort attribute choice by name.""" + NAME + + """Sort attribute choice by slug.""" + SLUG +} + +input AttributeValueFilterInput @doc(category: "Attributes") { + search: String + ids: [ID!] +} + +type AttributeTranslation implements Node @doc(category: "Attributes") { + id: ID! + + """Translation language.""" + language: LanguageDisplay! + name: String! +} + +type ProductTypeCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [ProductTypeCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type ProductTypeCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: ProductType! + + """A cursor for use in pagination.""" + cursor: String! +} + +enum VariantAttributeScope @doc(category: "Products") { + ALL + VARIANT_SELECTION + NOT_VARIANT_SELECTION +} + +""" +Represents assigned attribute to variant with variant selection attached. + +Added in Saleor 3.1. +""" +type AssignedVariantAttribute @doc(category: "Attributes") { + """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! +} + +type AttributeCountableConnection @doc(category: "Attributes") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [AttributeCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type AttributeCountableEdge @doc(category: "Attributes") { + """The item at the end of the edge.""" + node: Attribute! + + """A cursor for use in pagination.""" + cursor: String! +} + +input AttributeFilterInput @doc(category: "Attributes") { + 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 MetadataFilter { + """Key of a metadata item.""" + key: String! + + """Value of a metadata item.""" + value: String +} + +""" +Where filtering options. + +Added in Saleor 3.11. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +input AttributeWhereInput @doc(category: "Attributes") { + valueRequired: Boolean + visibleInStorefront: Boolean + filterableInDashboard: Boolean + metadata: [MetadataFilter!] + ids: [ID!] + name: StringFilterInput + slug: StringFilterInput + withChoices: Boolean + inputType: AttributeInputTypeEnumFilterInput + entityType: AttributeEntityTypeEnumFilterInput + type: AttributeTypeEnumFilterInput + unit: MeasurementUnitsEnumFilterInput + inCollection: ID + inCategory: ID + + """List of conditions that must be met.""" + AND: [AttributeWhereInput!] + + """A list of conditions of which at least one must be met.""" + OR: [AttributeWhereInput!] +} + +""" +Define the filtering options for string fields. + +Added in Saleor 3.11. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +input StringFilterInput { + """The value equal to.""" + eq: String + + """The value included in.""" + oneOf: [String!] +} + +input AttributeInputTypeEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: AttributeInputTypeEnum + + """The value included in.""" + oneOf: [AttributeInputTypeEnum!] +} + +input AttributeEntityTypeEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: AttributeEntityTypeEnum + + """The value included in.""" + oneOf: [AttributeEntityTypeEnum!] +} + +input AttributeTypeEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: AttributeTypeEnum + + """The value included in.""" + oneOf: [AttributeTypeEnum!] +} + +input MeasurementUnitsEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: MeasurementUnitsEnum + + """The value included in.""" + oneOf: [MeasurementUnitsEnum!] +} + +""" +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 @doc(category: "Products") { + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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( + """ + Filtering options for products. + + Added in Saleor 3.10. + """ + filter: ProductFilterInput + + """ + Filtering options for products. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + where: ProductWhereInput + + """ + Sort products. + + Added in Saleor 3.10. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): CategoryCountableConnection + backgroundImage( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.6. + """ + format: ThumbnailFormatEnum = ORIGINAL + ): Image + + """Returns translated category fields for the given language code.""" + translation( + """A language code to return the translation for category.""" + languageCode: LanguageCodeEnum! + ): CategoryTranslation +} + +type CategoryCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [CategoryCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type CategoryCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: Category! + + """A cursor for use in pagination.""" + cursor: String! +} + +input ProductFilterInput @doc(category: "Products") { + 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 +} + +input AttributeInput @doc(category: "Attributes") { + """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 +} + +input IntRangeInput { + """Value greater than or equal to.""" + gte: Int + + """Value less than or equal to.""" + lte: Int +} + +input DateTimeRangeInput { + """Start date.""" + gte: DateTime + + """End date.""" + lte: DateTime +} + +input DateRangeInput { + """Start date.""" + gte: Date + + """End date.""" + lte: Date +} + +enum StockAvailability @doc(category: "Products") { + IN_STOCK + OUT_OF_STOCK +} + +input ProductStockFilterInput @doc(category: "Products") { + warehouseIds: [ID!] + quantity: IntRangeInput +} + +input PriceRangeInput { + """Price greater than or equal to.""" + gte: Float + + """Price less than or equal to.""" + lte: Float +} + +input ProductWhereInput @doc(category: "Products") { + metadata: [MetadataFilter!] + ids: [ID!] + + """Filter by product name.""" + name: StringFilterInput + + """Filter by product slug.""" + slug: StringFilterInput + + """Filter by product type.""" + productType: GlobalIDFilterInput + + """Filter by product category.""" + category: GlobalIDFilterInput + + """Filter by collection.""" + collection: GlobalIDFilterInput + + """Filter by availability for purchase.""" + isAvailable: Boolean + + """Filter by public visibility.""" + isPublished: Boolean + + """Filter by visibility on the channel.""" + isVisibleInListing: Boolean + + """Filter by the publication date.""" + publishedFrom: DateTime + + """Filter by the date of availability for purchase.""" + availableFrom: DateTime + + """Filter by product with category assigned.""" + hasCategory: Boolean + + """Filter by product variant price.""" + price: DecimalFilterInput + + """Filter by the lowest variant price after discounts.""" + minimalPrice: DecimalFilterInput + + """Filter by attributes associated with the product.""" + attributes: [AttributeInput!] + + """Filter by variants having specific stock status.""" + stockAvailability: StockAvailability + + """Filter by stock of the product variant.""" + stocks: ProductStockFilterInput + + """Filter on whether product is a gift card or not.""" + giftCard: Boolean + + """Filter by product with preordered variants.""" + hasPreorderedVariants: Boolean + + """Filter by when was the most recent update.""" + updatedAt: DateTimeRangeInput + + """List of conditions that must be met.""" + AND: [ProductWhereInput!] + + """A list of conditions of which at least one must be met.""" + OR: [ProductWhereInput!] +} + +""" +Define the filtering options for foreign key fields. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +input GlobalIDFilterInput { + """The value equal to.""" + eq: ID + + """The value included in.""" + oneOf: [ID!] +} + +""" +Define the filtering options for decimal fields. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +input DecimalFilterInput { + """The value equal to.""" + eq: Decimal + + """The value included in.""" + oneOf: [Decimal!] + + """The value in range.""" + range: DecimalRangeInput +} + +""" +Custom Decimal implementation. + +Returns Decimal as a float in the API, +parses float to the Decimal on the way back. +""" +scalar Decimal + +input DecimalRangeInput { + """Decimal value greater than or equal to.""" + gte: Decimal + + """Decimal value less than or equal to.""" + lte: Decimal +} + +input ProductOrder @doc(category: "Products") { + """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 @doc(category: "Products") { + """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 an image.""" +type Image { + """The URL of the image.""" + url: String! + + """Alt text for an image.""" + alt: String +} + +"""An enumeration.""" +enum ThumbnailFormatEnum { + ORIGINAL + AVIF + WEBP +} + +type CategoryTranslation implements Node @doc(category: "Products") { + 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.") +} + +"""Represents a version of a product such as different size or color.""" +type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Products") { + 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. + """ + preorder: PreorderData + created: DateTime! + updatedAt: DateTime! + + """ + External ID of this product. + + Added in Saleor 3.10. + """ + externalReference: String +} + +"""Represents product variant channel listing.""" +type ProductVariantChannelListing implements Node @doc(category: "Products") { + 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. + """ + preorderThreshold: PreorderThreshold +} + +"""Represents preorder variant data for channel.""" +type PreorderThreshold @doc(category: "Products") { + """Preorder threshold for product variant in this channel.""" + quantity: Int + + """Number of sold product variant in this channel.""" + soldUnits: Int! +} + +"""Represents availability of a variant in the storefront.""" +type VariantPricingInfo @doc(category: "Products") { + """Whether it is in sale or not.""" + onSale: Boolean + + """The discount amount if in sale (null otherwise).""" + discount: TaxedMoney + + """The discount amount in the local currency.""" + discountLocalCurrency: TaxedMoney + + """The price, with any discount subtracted.""" + price: TaxedMoney + + """The price without any discount.""" + priceUndiscounted: TaxedMoney + + """The discounted price in the local currency.""" + priceLocalCurrency: TaxedMoney +} + +""" +Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal. +""" +type TaxedMoney { + """Currency code.""" + currency: String! + + """Amount of money including taxes.""" + gross: Money! + + """Amount of money without taxes.""" + net: Money! + + """Amount of taxes.""" + tax: Money! +} + +input AddressInput { + """Given name.""" + firstName: String + + """Family name.""" + lastName: String + + """Company or organization.""" + companyName: String + + """Address.""" + streetAddress1: String + + """Address.""" + streetAddress2: String + + """City.""" + city: String + + """District.""" + cityArea: String + + """Postal code.""" + postalCode: String + + """Country.""" + country: CountryCode + + """State or province.""" + countryArea: String + + """Phone number.""" + phone: String +} + +"""Represents a custom attribute.""" +type SelectedAttribute @doc(category: "Attributes") { + """Name of an attribute displayed in the interface.""" + attribute: Attribute! + + """Values of an attribute.""" + values: [AttributeValue!]! +} + +enum ReportingPeriod { + TODAY + THIS_MONTH +} + +"""Represents a product image.""" +type ProductImage @doc(category: "Products") { + """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( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.6. + """ + format: ThumbnailFormatEnum = ORIGINAL + ): String! +} + +"""Represents a product media.""" +type ProductMedia implements Node & ObjectWithMetadata @doc(category: "Products") { + id: ID! + + """ + List of private metadata items. Requires staff permissions to access. + + Added in Saleor 3.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + 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.12. + + 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.12. + + 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. + + Added in Saleor 3.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + metadata: [MetadataItem!]! + + """ + A single key from public metadata. + + Tip: Use GraphQL aliases to fetch multiple keys. + + Added in Saleor 3.12. + + 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.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + metafields(keys: [String!]): Metadata + sortOrder: Int + alt: String! + type: ProductMediaType! + oembedData: JSONString! + url( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.6. + """ + format: ThumbnailFormatEnum = ORIGINAL + ): String! + + """ + Product id the media refers to. + + Added in Saleor 3.12. + """ + productId: ID +} + +"""An enumeration.""" +enum ProductMediaType @doc(category: "Products") { + IMAGE + VIDEO +} + +type ProductVariantTranslation implements Node @doc(category: "Products") { + id: ID! + + """Translation language.""" + language: LanguageDisplay! + name: String! +} + +type DigitalContent implements Node & ObjectWithMetadata @doc(category: "Products") { + 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 DigitalContentUrl implements Node @doc(category: "Products") { + id: ID! + content: DigitalContent! + created: DateTime! + downloadNum: Int! + + """URL for digital content.""" + url: String + + """UUID of digital content.""" + token: UUID! +} + +scalar UUID + +"""Represents stock.""" +type Stock implements Node @doc(category: "Products") { + 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! +} + +"""Represents preorder settings for product variant.""" +type PreorderData @doc(category: "Products") { + """ + 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 +} + +"""Represents availability of a product in the storefront.""" +type ProductPricingInfo @doc(category: "Products") { + """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. + """ + displayGrossPrices: Boolean! +} + +"""Represents a range of monetary values.""" +type TaxedMoneyRange { + """Lower bound of a price range.""" + start: TaxedMoney + + """Upper bound of a price range.""" + stop: TaxedMoney +} + +"""Represents product channel listing.""" +type ProductChannelListing implements Node @doc(category: "Products") { + 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 +} + +type Margin @doc(category: "Products") { + start: Int + stop: Int +} + +input MediaSortingInput @doc(category: "Products") { + """Specifies the direction in which to sort media.""" + direction: OrderDirection! + + """Sort media by the selected field.""" + field: MediaChoicesSortField! +} + +enum MediaChoicesSortField @doc(category: "Products") { + """Sort media by ID.""" + ID +} + +"""Represents a collection of products.""" +type Collection implements Node & ObjectWithMetadata @doc(category: "Products") { + 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 + + """ + Filtering options for products. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + where: ProductWhereInput + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): ProductCountableConnection + backgroundImage( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.6. + """ + format: ThumbnailFormatEnum = ORIGINAL + ): 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!] +} + +type CollectionTranslation implements Node @doc(category: "Products") { + 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.") +} + +"""Represents collection channel listing.""" +type CollectionChannelListing implements Node @doc(category: "Products") { + 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 ProductTranslation implements Node @doc(category: "Products") { + 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.") +} + +type WarehouseCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [WarehouseCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type WarehouseCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: Warehouse! + + """A cursor for use in pagination.""" + cursor: String! +} + +input WarehouseFilterInput @doc(category: "Products") { + clickAndCollectOption: WarehouseClickAndCollectOptionEnum + search: String + ids: [ID!] + isPrivate: Boolean + channels: [ID!] + slugs: [String!] +} + +input WarehouseSortingInput @doc(category: "Products") { + """Specifies the direction in which to sort warehouses.""" + direction: OrderDirection! + + """Sort warehouses by the selected field.""" + field: WarehouseSortField! +} + +enum WarehouseSortField @doc(category: "Products") { + """Sort warehouses by name.""" + NAME +} + +type TranslatableItemConnection { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [TranslatableItemEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type TranslatableItemEdge { + """The item at the end of the edge.""" + node: TranslatableItem! + + """A cursor for use in pagination.""" + cursor: String! +} + +union TranslatableItem = ProductTranslatableContent | CollectionTranslatableContent | CategoryTranslatableContent | AttributeTranslatableContent | AttributeValueTranslatableContent | ProductVariantTranslatableContent | PageTranslatableContent | ShippingMethodTranslatableContent | SaleTranslatableContent | VoucherTranslatableContent | MenuItemTranslatableContent + +type ProductTranslatableContent implements Node @doc(category: "Products") { + 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!]! +} + +type AttributeValueTranslatableContent implements Node @doc(category: "Attributes") { + 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 +} + +type AttributeTranslatableContent implements Node @doc(category: "Attributes") { + 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.") +} + +type CollectionTranslatableContent implements Node @doc(category: "Products") { + 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.") +} + +type CategoryTranslatableContent implements Node @doc(category: "Products") { + 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.") +} + +type ProductVariantTranslatableContent implements Node @doc(category: "Products") { + 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!]! +} + +type PageTranslatableContent implements Node @doc(category: "Pages") { + 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!]! +} + +type PageTranslation implements Node @doc(category: "Pages") { + 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.") +} + +""" +A static page that can be manually added by a shop operator through the dashboard. +""" +type Page implements Node & ObjectWithMetadata @doc(category: "Pages") { + 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!]! +} + +""" +Represents a type of page. It defines what attributes are available to pages of this type. +""" +type PageType implements Node & ObjectWithMetadata @doc(category: "Pages") { + 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, MANAGE_PAGE_TYPES_AND_ATTRIBUTES. + """ + availableAttributes( + filter: AttributeFilterInput + where: AttributeWhereInput + + """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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): AttributeCountableConnection + + """ + Whether page type has pages assigned. + + Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES. + """ + hasPages: Boolean +} + +type ShippingMethodTranslatableContent implements Node @doc(category: "Shipping") { + 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 SaleTranslatableContent implements Node @doc(category: "Discounts") { + 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.") +} + +type SaleTranslation implements Node @doc(category: "Discounts") { + id: ID! + + """Translation language.""" + language: LanguageDisplay! + name: String +} + +""" +Sales allow creating discounts for categories, collections or products and are visible to all the customers. +""" +type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 +} + +enum SaleType @doc(category: "Discounts") { + FIXED + PERCENTAGE +} + +type CollectionCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [CollectionCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type CollectionCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: Collection! + + """A cursor for use in pagination.""" + cursor: String! +} + +type ProductVariantCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [ProductVariantCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type ProductVariantCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: ProductVariant! + + """A cursor for use in pagination.""" + cursor: String! +} + +"""Represents sale channel listing.""" +type SaleChannelListing implements Node @doc(category: "Discounts") { + id: ID! + channel: Channel! + discountValue: Float! + currency: String! +} + +type VoucherTranslatableContent implements Node @doc(category: "Discounts") { + 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.") +} + +type VoucherTranslation implements Node @doc(category: "Discounts") { + id: ID! + + """Translation language.""" + language: LanguageDisplay! + name: String +} + +""" +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 @doc(category: "Discounts") { + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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!] +} + +enum DiscountValueTypeEnum @doc(category: "Discounts") { + FIXED + PERCENTAGE +} + +enum VoucherTypeEnum @doc(category: "Discounts") { + SHIPPING + ENTIRE_ORDER + SPECIFIC_PRODUCT +} + +"""Represents voucher channel listing.""" +type VoucherChannelListing implements Node @doc(category: "Discounts") { + id: ID! + channel: Channel! + discountValue: Float! + currency: String! + minSpent: Money +} + +type MenuItemTranslatableContent implements Node @doc(category: "Menu") { + 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.") +} + +type MenuItemTranslation implements Node @doc(category: "Menu") { + id: ID! + + """Translation language.""" + language: LanguageDisplay! + name: String! +} + +""" +Represents a single item of the related menu. Can store categories, collection or pages. +""" +type MenuItem implements Node & ObjectWithMetadata @doc(category: "Menu") { + 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 +} + +""" +Represents a single menu - an object that is used to help navigate through the store. +""" +type Menu implements Node & ObjectWithMetadata @doc(category: "Menu") { + 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!] +} + +enum TranslatableKinds { + ATTRIBUTE + ATTRIBUTE_VALUE + CATEGORY + COLLECTION + MENU_ITEM + PAGE + PRODUCT + SALE + SHIPPING_METHOD + VARIANT + VOUCHER +} + +""" +Channel-specific tax configuration. + +Added in Saleor 3.9. +""" +type TaxConfiguration implements Node & ObjectWithMetadata @doc(category: "Taxes") { + """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!]! +} + +enum TaxCalculationStrategy @doc(category: "Taxes") { + FLAT_RATES + TAX_APP +} + +""" +Country-specific exceptions of a channel's tax configuration. + +Added in Saleor 3.9. +""" +type TaxConfigurationPerCountry @doc(category: "Taxes") { + """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! +} + +type TaxConfigurationCountableConnection @doc(category: "Taxes") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [TaxConfigurationCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type TaxConfigurationCountableEdge @doc(category: "Taxes") { + """The item at the end of the edge.""" + node: TaxConfiguration! + + """A cursor for use in pagination.""" + cursor: String! +} + +input TaxConfigurationFilterInput @doc(category: "Taxes") { + metadata: [MetadataFilter!] + ids: [ID!] +} + +type TaxClassCountableConnection @doc(category: "Taxes") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [TaxClassCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type TaxClassCountableEdge @doc(category: "Taxes") { + """The item at the end of the edge.""" + node: TaxClass! + + """A cursor for use in pagination.""" + cursor: String! +} + +input TaxClassSortingInput @doc(category: "Taxes") { + """Specifies the direction in which to sort tax classes.""" + direction: OrderDirection! + + """Sort tax classes by the selected field.""" + field: TaxClassSortField! +} + +enum TaxClassSortField @doc(category: "Taxes") { + """Sort tax classes by name.""" + NAME +} + +input TaxClassFilterInput @doc(category: "Taxes") { + metadata: [MetadataFilter!] + ids: [ID!] + countries: [CountryCode!] +} + +""" +Tax class rates grouped by country. + +Added in Saleor 3.9. +""" +type TaxCountryConfiguration @doc(category: "Taxes") { + """A country for which tax class rates are grouped.""" + country: CountryDisplay! + + """List of tax class rates.""" + taxClassCountryRates: [TaxClassCountryRate!]! +} + +type StockCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [StockCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type StockCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: Stock! + + """A cursor for use in pagination.""" + cursor: String! +} + +input StockFilterInput @doc(category: "Products") { + quantity: Float + search: String +} + +""" +Represents a shop resource containing general shop data and configuration. +""" +type Shop { + """List of available payment gateways.""" + availablePaymentGateways( + """ + A currency for which gateways will be returned. + + 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. + + 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!] + + """ + Determines if account confirmation by email is enabled. + + Added in Saleor 3.14. + + Requires one of the following permissions: MANAGE_SETTINGS. + """ + enableAccountConfirmationByEmail: Boolean + + """ + 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! + + """ + Minor Saleor API version. + + Added in Saleor 3.5. + """ + schemaVersion: 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.") +} + +""" +Available payment gateway backend with configuration necessary to setup client. +""" +type PaymentGateway @doc(category: "Payments") { + """Payment gateway name.""" + name: String! + + """Payment gateway ID.""" + id: ID! + + """Payment gateway client configuration.""" + config: [GatewayConfigLine!]! + + """Payment gateway supported currencies.""" + currencies: [String!]! +} + +"""Payment gateway client configuration key and value pair.""" +type GatewayConfigLine @doc(category: "Payments") { + """Gateway config key.""" + field: String! + + """Gateway config value for key.""" + value: String +} + +type ExternalAuthentication @doc(category: "Authentication") { + """ID of external authentication plugin.""" + id: String! + + """Name of external authentication plugin.""" + name: String +} + +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 +} + +"""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! +} + +type ShopTranslation implements Node @doc(category: "Shop") { + id: ID! + + """Translation language.""" + language: LanguageDisplay! + headerText: String! + description: String! +} + +""" +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 +} + +"""Represents user data.""" +type User implements Node & ObjectWithMetadata @doc(category: "Users") { + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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 + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + 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!] + + """ + List of channels the user has access to. The sum of channels from all user groups. If at least one group has `restrictedAccessToChannels` set to False - all channels are returned. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + accessibleChannels: [Channel!] + + """ + Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + restrictedAccessToChannels: Boolean! + avatar( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.6. + """ + format: ThumbnailFormatEnum = ORIGINAL + ): 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 + + """ + External ID of this user. + + Added in Saleor 3.10. + """ + externalReference: String + lastLogin: DateTime + dateJoined: DateTime! + updatedAt: DateTime! +} + +"""Checkout object.""" +type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { + 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! + + """ + Time of last modification of the given checkout. + + Added in Saleor 3.13. + """ + updatedAt: DateTime! + lastChange: DateTime! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `updatedAt` instead.") + 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. + """ + 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. + """ + 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. + """ + 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! + + """ + The difference between the paid and the checkout total amount. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + totalBalance: Money! + + """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. + """ + displayGrossPrices: Boolean! + + """ + The authorize status of the checkout. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + authorizeStatus: CheckoutAuthorizeStatusEnum! + + """ + The charge status of the checkout. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + chargeStatus: CheckoutChargeStatusEnum! +} + +""" +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 @doc(category: "Gift cards") { + 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. + """ + createdBy: User + + """ + The customer who used a gift card. + + Added in Saleor 3.1. + """ + usedBy: User @deprecated(reason: "This field will be removed in Saleor 4.0.") + + """ + Email address of the user who bought or issued gift card. + + Added in Saleor 3.1. + + 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. + """ + usedByEmail: String @deprecated(reason: "This field will be removed in Saleor 4.0.") + lastUsedOn: DateTime + expiryDate: Date + + """ + App which created the gift card. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_APPS, OWNER. + """ + app: App + + """ + Related gift card product. + + Added in Saleor 3.1. + """ + product: Product + + """ + List of events associated with the gift card. + + Added in Saleor 3.1. + + 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. + + 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. + """ + 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.") +} + +""" +History log of the gift card. + +Added in Saleor 3.1. +""" +type GiftCardEvent implements Node @doc(category: "Gift cards") { + 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 +} + +"""An enumeration.""" +enum GiftCardEventsEnum @doc(category: "Gift cards") { + ISSUED + BOUGHT + UPDATED + ACTIVATED + DEACTIVATED + BALANCE_RESET + EXPIRY_DATE_UPDATED + TAGS_UPDATED + SENT_TO_CUSTOMER + RESENT + NOTE_ADDED + USED_IN_ORDER +} + +type GiftCardEventBalance @doc(category: "Gift cards") { + """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 @doc(category: "Gift cards") { + type: GiftCardEventsEnum + orders: [ID!] +} + +""" +The gift card tag. + +Added in Saleor 3.1. +""" +type GiftCardTag implements Node @doc(category: "Gift cards") { + id: ID! + name: String! +} + +"""Represents an item in the checkout.""" +type CheckoutLine implements Node & ObjectWithMetadata @doc(category: "Checkout") { + id: ID! + + """ + List of private metadata items. Requires staff permissions to access. + + Added in Saleor 3.5. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + 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.5. + + 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.5. + + 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. + + Added in Saleor 3.5. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + metadata: [MetadataItem!]! + + """ + A single key from public metadata. + + Tip: Use GraphQL aliases to fetch multiple keys. + + Added in Saleor 3.5. + + 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.5. + + 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! +} + +""" +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. +""" +union DeliveryMethod = Warehouse | ShippingMethod + +""" +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 @doc(category: "Payments") { + """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 of ongoing authorization requests for the transaction. + + Added in Saleor 3.13. + """ + authorizePendingAmount: Money! + + """Total amount refunded for this payment.""" + refundedAmount: Money! + + """ + Total amount of ongoing refund requests for the transaction. + + Added in Saleor 3.13. + """ + refundPendingAmount: Money! + + """Total amount voided for this payment.""" + voidedAmount: Money! @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature).Use `canceledAmount` instead.") + + """ + Total amount canceled for this payment. + + Added in Saleor 3.13. + """ + canceledAmount: Money! + + """ + Total amount of ongoing cancel requests for the transaction. + + Added in Saleor 3.13. + """ + cancelPendingAmount: Money! + + """Total amount charged for this payment.""" + chargedAmount: Money! + + """ + Total amount of ongoing charge requests for the transaction. + + Added in Saleor 3.13. + """ + chargePendingAmount: Money! + + """Status of transaction.""" + status: String! @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature). The `status` is not needed. The amounts can be used to define the current status of transactions.") + + """Type of transaction.""" + type: String! @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature). Use `name` or `message` instead.") + + """ + Name of the transaction. + + Added in Saleor 3.13. + """ + name: String! + + """ + Message related to the transaction. + + Added in Saleor 3.13. + """ + message: String! + + """Reference of transaction.""" + reference: String! @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature).Use `pspReference` instead.") + + """ + PSP reference of transaction. + + Added in Saleor 3.13. + """ + pspReference: String! + + """ + The related order. + + Added in Saleor 3.6. + """ + order: Order + + """List of all transaction's events.""" + events: [TransactionEvent!]! + + """ + User or App that created the transaction. + + Added in Saleor 3.13. + """ + createdBy: UserOrApp + + """ + The url that will allow to redirect user to payment provider page with transaction details. + + Added in Saleor 3.13. + """ + externalUrl: String! +} + +""" +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. This field will be removed + in Saleor 3.14 (Preview Feature). Use `CANCEL` instead. + CANCEL - Represents a cancel action. Added in Saleor 3.12. +""" +enum TransactionActionEnum @doc(category: "Payments") { + CHARGE + REFUND + VOID + CANCEL +} + +"""Represents an order in the shop.""" +type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { + 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. + """ + 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. + """ + authorizeStatus: OrderAuthorizeStatusEnum! + + """ + The charge status of the order. + + Added in Saleor 3.4. + """ + chargeStatus: OrderChargeStatusEnum! + + """ + Returns True if order has to be exempt from taxes. + + Added in Saleor 3.8. + """ + taxExemption: Boolean! + + """ + List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. + + Added in Saleor 3.4. + """ + 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. + + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. + """ + shippingTaxClass: TaxClass + + """ + Denormalized name of the tax class assigned to the shipping method. + + Added in Saleor 3.9. + """ + shippingTaxClassName: String + + """ + Denormalized public metadata of the shipping method's tax class. + + Added in Saleor 3.9. + """ + shippingTaxClassMetadata: [MetadataItem!]! + + """ + Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access. + + Added in Saleor 3.9. + """ + 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 for the order.""" + totalCaptured: Money! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `totalCharged` instead.") + + """ + Amount charged for the order. + + Added in Saleor 3.13. + """ + totalCharged: Money! + + """ + Amount canceled for the order. + + Added in Saleor 3.13. + """ + totalCanceled: 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. + """ + 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. + """ + displayGrossPrices: Boolean! + + """ + External ID of this order. + + Added in Saleor 3.10. + """ + externalReference: String + + """ + ID of the checkout that the order was created from. + + Added in Saleor 3.11. + """ + checkoutId: ID + + """ + List of granted refunds. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + grantedRefunds: [OrderGrantedRefund!]! + + """ + Total amount of granted refund. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + totalGrantedRefund: Money! + + """ + Total refund amount for the order. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + totalRefunded: Money! + + """ + Total amount of ongoing refund requests for the order's transactions. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + totalRefundPending: Money! + + """ + Total amount of ongoing authorize requests for the order's transactions. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + totalAuthorizePending: Money! + + """ + Total amount of ongoing charge requests for the order's transactions. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + totalChargePending: Money! + + """ + Total amount of ongoing cancel requests for the order's transactions. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + totalCancelPending: Money! + + """ + The difference amount between granted refund and the amounts that are pending and refunded. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + totalRemainingGrant: Money! +} + +"""An enumeration.""" +enum OrderStatus @doc(category: "Orders") { + DRAFT + UNCONFIRMED + UNFULFILLED + PARTIALLY_FULFILLED + PARTIALLY_RETURNED + RETURNED + FULFILLED + CANCELED + EXPIRED +} + +"""Represents order fulfillment.""" +type Fulfillment implements Node & ObjectWithMetadata @doc(category: "Orders") { + 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 +} + +"""An enumeration.""" +enum FulfillmentStatus @doc(category: "Orders") { + FULFILLED + REFUNDED + RETURNED + REPLACED + REFUNDED_AND_RETURNED + CANCELED + WAITING_FOR_APPROVAL +} + +"""Represents line of the fulfillment.""" +type FulfillmentLine implements Node @doc(category: "Orders") { + id: ID! + quantity: Int! + orderLine: OrderLine +} + +"""Represents order line of particular order.""" +type OrderLine implements Node & ObjectWithMetadata @doc(category: "Orders") { + id: ID! + + """ + List of private metadata items. Requires staff permissions to access. + + Added in Saleor 3.5. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + 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.5. + + 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.5. + + 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. + + Added in Saleor 3.5. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + metadata: [MetadataItem!]! + + """ + A single key from public metadata. + + Tip: Use GraphQL aliases to fetch multiple keys. + + Added in Saleor 3.5. + + 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.5. + + 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( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.6. + """ + format: ThumbnailFormatEnum = ORIGINAL + ): 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. + + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. + """ + taxClass: TaxClass + + """ + Denormalized name of the tax class. + + Added in Saleor 3.9. + """ + taxClassName: String + + """ + Denormalized public metadata of the tax class. + + Added in Saleor 3.9. + """ + taxClassMetadata: [MetadataItem!]! + + """ + Denormalized private metadata of the tax class. Requires staff permissions to access. + + Added in Saleor 3.9. + """ + taxClassPrivateMetadata: [MetadataItem!]! +} + +""" +Nonnegative Decimal scalar implementation. + +Should be used in places where value must be nonnegative (0 or greater). +""" +scalar PositiveDecimal + +"""Represents allocation.""" +type Allocation implements Node @doc(category: "Products") { + 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! +} + +enum OrderAction @doc(category: "Payments") { + """Represents the capture action.""" + CAPTURE + + """Represents a mark-as-paid action.""" + MARK_AS_PAID + + """Represents a refund action.""" + REFUND + + """Represents a void action.""" + VOID +} + +"""Represents an Invoice.""" +type Invoice implements ObjectWithMetadata & Job & Node @doc(category: "Orders") { + """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 + + """ + Order related to the invoice. + + Added in Saleor 3.10. + """ + order: Order +} + +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 OrderOriginEnum @doc(category: "Orders") { + CHECKOUT + DRAFT + REISSUE + BULK_CREATE +} + +"""An enumeration.""" +enum PaymentChargeStatusEnum @doc(category: "Payments") { + NOT_CHARGED + PENDING + PARTIALLY_CHARGED + FULLY_CHARGED + PARTIALLY_REFUNDED + FULLY_REFUNDED + REFUSED + CANCELLED +} + +""" +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`-`order.totalGrantedRefund`. + We treat the order as partially authorized when the sum of authorized and charged + funds covers only part of the `order.total`-`order.totalGrantedRefund`. + 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 and charged don't cover fully the + `order.total`-`order.totalGrantedRefund` + FULL - the funds that are authorized and charged fully cover the + `order.total`-`order.totalGrantedRefund` +""" +enum OrderAuthorizeStatusEnum @doc(category: "Orders") { + NONE + PARTIAL + FULL +} + +""" +Determine the current charge status for the order. + + An order is considered overcharged when the sum of the + transactionItem's charge amounts exceeds the value of + `order.total` - `order.totalGrantedRefund`. + If the sum of the transactionItem's charge amounts equals + `order.total` - `order.totalGrantedRefund`, we consider the order to be fully + charged. + If the sum of the transactionItem's charge amounts covers a part of the + `order.total` - `order.totalGrantedRefund`, we treat the order as partially charged. + + NONE - the funds are not charged. + PARTIAL - the funds that are charged don't cover the + `order.total`-`order.totalGrantedRefund` + FULL - the funds that are charged fully cover the + `order.total`-`order.totalGrantedRefund` + OVERCHARGED - the charged funds are bigger than the + `order.total`-`order.totalGrantedRefund` +""" +enum OrderChargeStatusEnum @doc(category: "Orders") { + NONE + PARTIAL + FULL + OVERCHARGED +} + +"""Represents a payment of a given type.""" +type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") { + 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 +} + +"""An object representing a single payment.""" +type Transaction implements Node @doc(category: "Payments") { + id: ID! + created: DateTime! + payment: Payment! + token: String! + kind: TransactionKind! + isSuccess: Boolean! + error: String + gatewayResponse: JSONString! + + """Total amount of the transaction.""" + amount: Money +} + +"""An enumeration.""" +enum TransactionKind @doc(category: "Payments") { + EXTERNAL + AUTH + PENDING + ACTION_TO_CONFIRM + REFUND + REFUND_ONGOING + CAPTURE + VOID + CONFIRM + CANCEL +} + +type CreditCard @doc(category: "Payments") { + """Card brand.""" + brand: String! + + """First 4 digits of the card number.""" + firstDigits: String + + """Last 4 digits of the card number.""" + lastDigits: String! + + """Two-digit number representing the card’s expiration month.""" + expMonth: Int + + """Four-digit number representing the card’s expiration year.""" + expYear: Int +} + +"""History log of the order.""" +type OrderEvent implements Node @doc(category: "Orders") { + 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 @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature).Use `TransactionEvent` to track the status of `TransactionItem`.") + + """The reference of payment's transaction.""" + reference: String +} + +"""The different order event types.""" +enum OrderEventsEnum @doc(category: "Orders") { + DRAFT_CREATED + DRAFT_CREATED_FROM_REPLACE + ADDED_PRODUCTS + REMOVED_PRODUCTS + PLACED + PLACED_FROM_DRAFT + OVERSOLD_ITEMS + CANCELED + EXPIRED + 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_CHARGE_REQUESTED + + """ + This field will be removed in Saleor 3.15 (Preview Feature). Use `TRANSACTION_CHARGE_REQUESTED` instead. + """ + TRANSACTION_CAPTURE_REQUESTED + TRANSACTION_REFUND_REQUESTED + + """ + This field will be removed in Saleor 3.15 (Preview Feature). Use `TRANSACTION_CANCEL_REQUESTED` instead. + """ + TRANSACTION_VOID_REQUESTED + TRANSACTION_CANCEL_REQUESTED + TRANSACTION_MARK_AS_PAID_FAILED + 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 +} + +"""An enumeration.""" +enum OrderEventsEmailsEnum @doc(category: "Orders") { + PAYMENT_CONFIRMATION + CONFIRMED + SHIPPING_CONFIRMATION + TRACKING_UPDATED + ORDER_CONFIRMATION + ORDER_CANCEL + ORDER_REFUND + FULFILLMENT_CONFIRMATION + DIGITAL_LINKS +} + +type OrderEventOrderLineObject @doc(category: "Orders") { + """The variant quantity.""" + quantity: Int + + """The order line.""" + orderLine: OrderLine + + """The variant name.""" + itemName: String + + """The discount applied to the order line.""" + discount: OrderEventDiscountObject +} + +type OrderEventDiscountObject @doc(category: "Orders") { + """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 +} + +""" +Represents a status of payment transaction. + + The following statuses are possible: + SUCCESS - Represents a sucess action. + FAILURE - Represents a failure action. + PENDING - Represents a pending action. +""" +enum TransactionStatus @doc(category: "Payments") { + PENDING + SUCCESS + FAILURE +} + +"""Contains all details related to the applied discount to the order.""" +type OrderDiscount implements Node @doc(category: "Discounts") { + 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! +} + +"""An enumeration.""" +enum OrderDiscountType @doc(category: "Discounts") { + SALE + VOUCHER + MANUAL +} + +type OrderError @doc(category: "Orders") { + """ + 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 @doc(category: "Orders") { + 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 + TRANSACTION_ERROR + 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 +} + +"""An enumeration.""" +enum AddressTypeEnum { + BILLING + SHIPPING +} + +""" +The details of granted refund. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type OrderGrantedRefund @doc(category: "Orders") { + id: ID! + + """Time of creation.""" + createdAt: DateTime! + + """Time of last update.""" + updatedAt: DateTime! + + """Refund amount.""" + amount: Money! + + """Reason of the refund.""" + reason: String + + """ + User who performed the action. Requires of of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER. + """ + user: User + + """App that performed the action.""" + app: App +} + +"""Represents transaction's event.""" +type TransactionEvent implements Node @doc(category: "Payments") { + """The ID of the object.""" + id: ID! + createdAt: DateTime! + + """Status of transaction's event.""" + status: TransactionStatus @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature). Use `type` instead.") + + """Reference of transaction's event.""" + reference: String! @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature).Use `pspReference` instead.") + + """ + PSP reference of transaction. + + Added in Saleor 3.13. + """ + pspReference: String! + + """Name of the transaction's event.""" + name: String @deprecated(reason: "This field will be removed in Saleor 3.15 (Preview Feature). Use `message` instead.") + + """ + Message related to the transaction's event. + + Added in Saleor 3.13. + """ + message: String! + + """ + The url that will allow to redirect user to payment provider page with transaction details. + + Added in Saleor 3.13. + """ + externalUrl: String! + + """ + The amount related to this event. + + Added in Saleor 3.13. + """ + amount: Money! + + """ + The type of action related to this event. + + Added in Saleor 3.13. + """ + type: TransactionEventTypeEnum + + """ + User or App that created the transaction event. + + Added in Saleor 3.13. + """ + createdBy: UserOrApp +} + +""" +Represents possible event types. + + Added in Saleor 3.12. + + The following types are possible: + AUTHORIZATION_SUCCESS - represents success authorization. + AUTHORIZATION_FAILURE - represents failure authorization. + AUTHORIZATION_ADJUSTMENT - represents authorization adjustment. + AUTHORIZATION_REQUEST - represents authorization request. + AUTHORIZATION_ACTION_REQUIRED - represents authorization that needs + additional actions from the customer. + CHARGE_ACTION_REQUIRED - represents charge that needs + additional actions from the customer. + CHARGE_SUCCESS - represents success charge. + CHARGE_FAILURE - represents failure charge. + CHARGE_BACK - represents chargeback. + CHARGE_REQUEST - represents charge request. + REFUND_SUCCESS - represents success refund. + REFUND_FAILURE - represents failure refund. + REFUND_REVERSE - represents reverse refund. + REFUND_REQUEST - represents refund request. + CANCEL_SUCCESS - represents success cancel. + CANCEL_FAILURE - represents failure cancel. + CANCEL_REQUEST - represents cancel request. + INFO - represents info event. +""" +enum TransactionEventTypeEnum @doc(category: "Payments") { + AUTHORIZATION_SUCCESS + AUTHORIZATION_FAILURE + AUTHORIZATION_ADJUSTMENT + AUTHORIZATION_REQUEST + AUTHORIZATION_ACTION_REQUIRED + CHARGE_ACTION_REQUIRED + CHARGE_SUCCESS + CHARGE_FAILURE + CHARGE_BACK + CHARGE_REQUEST + REFUND_SUCCESS + REFUND_FAILURE + REFUND_REVERSE + REFUND_REQUEST + CANCEL_SUCCESS + CANCEL_FAILURE + CANCEL_REQUEST + INFO +} + +union UserOrApp = User | App + +""" +Determine a current authorize status for checkout. + + We treat the checkout as fully authorized when the sum of authorized and charged + funds cover the checkout.total. + We treat the checkout as partially authorized when the sum of authorized and charged + funds covers only part of the checkout.total + We treat the checkout as not authorized when the sum of authorized and charged funds + is 0. + + NONE - the funds are not authorized + PARTIAL - the cover funds don't cover fully the checkout's total + FULL - the cover funds covers the checkout's total +""" +enum CheckoutAuthorizeStatusEnum @doc(category: "Checkout") { + NONE + PARTIAL + FULL +} + +""" +Determine the current charge status for the checkout. + + The checkout is considered overcharged when the sum of the transactionItem's charge + amounts exceeds the value of `checkout.total`. + If the sum of the transactionItem's charge amounts equals + `checkout.total`, we consider the checkout to be fully charged. + If the sum of the transactionItem's charge amounts covers a part of the + `checkout.total`, we treat the checkout as partially charged. + + + NONE - the funds are not charged. + PARTIAL - the funds that are charged don't cover the checkout's total + FULL - the funds that are charged fully cover the checkout's total + OVERCHARGED - the charged funds are bigger than checkout's total +""" +enum CheckoutChargeStatusEnum @doc(category: "Checkout") { + NONE + PARTIAL + FULL + OVERCHARGED +} + +type CheckoutCountableConnection @doc(category: "Checkout") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [CheckoutCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type CheckoutCountableEdge @doc(category: "Checkout") { + """The item at the end of the edge.""" + node: Checkout! + + """A cursor for use in pagination.""" + cursor: String! +} + +type GiftCardCountableConnection @doc(category: "Gift cards") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [GiftCardCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type GiftCardCountableEdge @doc(category: "Gift cards") { + """The item at the end of the edge.""" + node: GiftCard! + + """A cursor for use in pagination.""" + cursor: String! +} + +type OrderCountableConnection @doc(category: "Orders") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [OrderCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type OrderCountableEdge @doc(category: "Orders") { + """The item at the end of the edge.""" + node: Order! + + """A cursor for use in pagination.""" + cursor: String! +} + +"""Represents user's permissions.""" +type UserPermission @doc(category: "Users") { + """Internal code for permission.""" + code: PermissionEnum! + + """Describe action(s) allowed to do by permission.""" + name: String! + + """List of user permission groups which contains this permission.""" + sourcePermissionGroups( + """ID of user whose groups should be returned.""" + userId: ID! + ): [Group!] +} + +"""Represents permission group data.""" +type Group implements Node @doc(category: "Users") { + 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! + + """ + List of channels the group has access to. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + accessibleChannels: [Channel!] + + """ + Determine if the group have restricted access to channels. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + restrictedAccessToChannels: Boolean! +} + +"""History log of the customer.""" +type CustomerEvent implements Node @doc(category: "Users") { + 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 @doc(category: "Users") { + 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 +} + +""" +Represents a payment source stored for user in payment gateway, such as credit card. +""" +type PaymentSource @doc(category: "Payments") { + """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!]! +} + +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 +} + +"""Gift card related settings from site settings.""" +type GiftCardSettings @doc(category: "Gift cards") { + """The gift card expiry type settings.""" + expiryType: GiftCardSettingsExpiryTypeEnum! + + """The gift card expiry period settings.""" + expiryPeriod: TimePeriod +} + +"""An enumeration.""" +enum GiftCardSettingsExpiryTypeEnum @doc(category: "Gift cards") { + NEVER_EXPIRE + EXPIRY_PERIOD +} + +type TimePeriod { + """The length of the period.""" + amount: Int! + + """The type of the period.""" + type: TimePeriodTypeEnum! +} + +"""An enumeration.""" +enum TimePeriodTypeEnum { + DAY + WEEK + MONTH + YEAR +} + +input ShippingZoneFilterInput @doc(category: "Shipping") { + search: String + channels: [ID!] +} + +type DigitalContentCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [DigitalContentCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type DigitalContentCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: DigitalContent! + + """A cursor for use in pagination.""" + cursor: String! +} + +input CategoryFilterInput @doc(category: "Products") { + search: String + metadata: [MetadataFilter!] + ids: [ID!] + slugs: [String!] +} + +input CategorySortingInput @doc(category: "Products") { + """Specifies the direction in which to sort categories.""" + 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! +} + +enum CategorySortField @doc(category: "Products") { + """Sort categories by name.""" + NAME + + """Sort categories by product count.""" + PRODUCT_COUNT + + """Sort categories by subcategory count.""" + SUBCATEGORY_COUNT +} + +input CollectionFilterInput @doc(category: "Products") { + 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 +} + +enum CollectionPublished @doc(category: "Products") { + PUBLISHED + HIDDEN +} + +input CollectionSortingInput @doc(category: "Products") { + """Specifies the direction in which to sort collections.""" + 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! +} + +enum CollectionSortField @doc(category: "Products") { + """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 ProductTypeFilterInput @doc(category: "Products") { + search: String + configurable: ProductTypeConfigurable + productType: ProductTypeEnum + metadata: [MetadataFilter!] + kind: ProductTypeKindEnum + ids: [ID!] + slugs: [String!] +} + +enum ProductTypeConfigurable @doc(category: "Products") { + CONFIGURABLE + SIMPLE +} + +enum ProductTypeEnum @doc(category: "Products") { + DIGITAL + SHIPPABLE +} + +input ProductTypeSortingInput @doc(category: "Products") { + """Specifies the direction in which to sort product types.""" + direction: OrderDirection! + + """Sort product types by the selected field.""" + field: ProductTypeSortField! +} + +enum ProductTypeSortField @doc(category: "Products") { + """Sort products by name.""" + NAME + + """Sort products by type.""" + DIGITAL + + """Sort products by shipping.""" + SHIPPING_REQUIRED +} + +input ProductVariantFilterInput @doc(category: "Products") { + search: String + sku: [String!] + metadata: [MetadataFilter!] + isPreorder: Boolean + updatedAt: DateTimeRangeInput +} + +input ProductVariantSortingInput @doc(category: "Products") { + """Specifies the direction in which to sort productVariants.""" + direction: OrderDirection! + + """Sort productVariants by the selected field.""" + field: ProductVariantSortField! +} + +enum ProductVariantSortField @doc(category: "Products") { + """Sort products variants by last modified at.""" + LAST_MODIFIED_AT +} + +type PaymentCountableConnection @doc(category: "Payments") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [PaymentCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type PaymentCountableEdge @doc(category: "Payments") { + """The item at the end of the edge.""" + node: Payment! + + """A cursor for use in pagination.""" + cursor: String! +} + +input PaymentFilterInput @doc(category: "Payments") { + """ + Filter by ids. + + Added in Saleor 3.8. + """ + ids: [ID!] + checkouts: [ID!] +} + +type PageCountableConnection @doc(category: "Pages") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [PageCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type PageCountableEdge @doc(category: "Pages") { + """The item at the end of the edge.""" + node: Page! + + """A cursor for use in pagination.""" + cursor: String! +} + +input PageSortingInput @doc(category: "Pages") { + """Specifies the direction in which to sort pages.""" + direction: OrderDirection! + + """Sort pages by the selected field.""" + field: PageSortField! +} + +enum PageSortField @doc(category: "Pages") { + """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 PageFilterInput @doc(category: "Pages") { + search: String + metadata: [MetadataFilter!] + pageTypes: [ID!] + ids: [ID!] + slugs: [String!] +} + +type PageTypeCountableConnection @doc(category: "Pages") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [PageTypeCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type PageTypeCountableEdge @doc(category: "Pages") { + """The item at the end of the edge.""" + node: PageType! + + """A cursor for use in pagination.""" + cursor: String! +} + +input PageTypeSortingInput @doc(category: "Pages") { + """Specifies the direction in which to sort page types.""" + direction: OrderDirection! + + """Sort page types by the selected field.""" + field: PageTypeSortField! +} + +enum PageTypeSortField @doc(category: "Pages") { + """Sort page types by name.""" + NAME + + """Sort page types by slug.""" + SLUG +} + +input PageTypeFilterInput @doc(category: "Pages") { + search: String + slugs: [String!] +} + +type OrderEventCountableConnection @doc(category: "Orders") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [OrderEventCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type OrderEventCountableEdge @doc(category: "Orders") { + """The item at the end of the edge.""" + node: OrderEvent! + + """A cursor for use in pagination.""" + cursor: String! +} + +input OrderSortingInput @doc(category: "Orders") { + """Specifies the direction in which to sort orders.""" + direction: OrderDirection! + + """Sort orders by the selected field.""" + field: OrderSortField! +} + +enum OrderSortField @doc(category: "Orders") { + """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 OrderFilterInput @doc(category: "Orders") { + 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!] + checkoutIds: [ID!] +} + +enum OrderStatusFilter @doc(category: "Orders") { + READY_TO_FULFILL + READY_TO_CAPTURE + UNFULFILLED + UNCONFIRMED + PARTIALLY_FULFILLED + FULFILLED + CANCELED +} + +input OrderDraftFilterInput @doc(category: "Orders") { + customer: String + created: DateRangeInput + search: String + metadata: [MetadataFilter!] + channels: [ID!] +} + +type MenuCountableConnection @doc(category: "Menu") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [MenuCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type MenuCountableEdge @doc(category: "Menu") { + """The item at the end of the edge.""" + node: Menu! + + """A cursor for use in pagination.""" + cursor: String! +} + +input MenuSortingInput { + """Specifies the direction in which to sort menus.""" + direction: OrderDirection! + + """Sort menus by the selected field.""" + field: MenuSortField! +} + +enum MenuSortField { + """Sort menus by name.""" + NAME + + """Sort menus by items count.""" + ITEMS_COUNT +} + +input MenuFilterInput { + search: String + slug: [String!] + metadata: [MetadataFilter!] + slugs: [String!] +} + +type MenuItemCountableConnection @doc(category: "Menu") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [MenuItemCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type MenuItemCountableEdge @doc(category: "Menu") { + """The item at the end of the edge.""" + node: MenuItem! + + """A cursor for use in pagination.""" + cursor: String! +} + +input MenuItemSortingInput { + """Specifies the direction in which to sort menu items.""" + direction: OrderDirection! + + """Sort menu items by the selected field.""" + field: MenuItemsSortField! +} + +enum MenuItemsSortField { + """Sort menu items by name.""" + NAME +} + +input MenuItemFilterInput { + search: String + metadata: [MetadataFilter!] +} + +input GiftCardSortingInput @doc(category: "Gift cards") { + """Specifies the direction in which to sort gift cards.""" + direction: OrderDirection! + + """Sort gift cards by the selected field.""" + field: GiftCardSortField! +} + +enum GiftCardSortField @doc(category: "Gift cards") { + """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 GiftCardFilterInput @doc(category: "Gift cards") { + isActive: Boolean + metadata: [MetadataFilter!] + tags: [String!] + products: [ID!] + usedBy: [ID!] + used: Boolean + currency: String + currentBalance: PriceRangeInput + initialBalance: PriceRangeInput + code: String +} + +type GiftCardTagCountableConnection @doc(category: "Gift cards") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [GiftCardTagCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type GiftCardTagCountableEdge @doc(category: "Gift cards") { + """The item at the end of the edge.""" + node: GiftCardTag! + + """A cursor for use in pagination.""" + cursor: String! +} + +input GiftCardTagFilterInput @doc(category: "Gift cards") { + search: String +} + +"""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!] +} + +"""Stores information about a single configuration field.""" +type ConfigurationItem { + """Name of the field.""" + name: String! + + """Current value of the field.""" + value: String + + """Type of the field.""" + type: ConfigurationTypeFieldEnum + + """Help text for the field.""" + helpText: String + + """Label for the field.""" + label: String +} + +"""An enumeration.""" +enum ConfigurationTypeFieldEnum { + STRING + MULTILINE + BOOLEAN + SECRET + PASSWORD + SECRETMULTILINE + OUTPUT +} + +type PluginCountableConnection { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [PluginCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type PluginCountableEdge { + """The item at the end of the edge.""" + node: Plugin! + + """A cursor for use in pagination.""" + cursor: String! +} + +input PluginFilterInput { + statusInChannels: PluginStatusInChannelsInput + search: String + type: PluginConfigurationType +} + +input PluginStatusInChannelsInput { + active: Boolean! + channels: [ID!]! +} + +enum PluginConfigurationType { + PER_CHANNEL + GLOBAL +} + +input PluginSortingInput { + """Specifies the direction in which to sort plugins.""" + direction: OrderDirection! + + """Sort plugins by the selected field.""" + field: PluginSortField! +} + +enum PluginSortField { + NAME + IS_ACTIVE +} + +type SaleCountableConnection @doc(category: "Discounts") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [SaleCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type SaleCountableEdge @doc(category: "Discounts") { + """The item at the end of the edge.""" + node: Sale! + + """A cursor for use in pagination.""" + cursor: String! +} + +input SaleFilterInput @doc(category: "Discounts") { + status: [DiscountStatusEnum!] + saleType: DiscountValueTypeEnum + started: DateTimeRangeInput + search: String + metadata: [MetadataFilter!] + updatedAt: DateTimeRangeInput +} + +enum DiscountStatusEnum @doc(category: "Discounts") { + ACTIVE + EXPIRED + SCHEDULED +} + +input SaleSortingInput @doc(category: "Discounts") { + """Specifies the direction in which to sort sales.""" + 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! +} + +enum SaleSortField @doc(category: "Discounts") { + """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 +} + +type VoucherCountableConnection @doc(category: "Discounts") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [VoucherCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type VoucherCountableEdge @doc(category: "Discounts") { + """The item at the end of the edge.""" + node: Voucher! + + """A cursor for use in pagination.""" + cursor: String! +} + +input VoucherFilterInput @doc(category: "Discounts") { + status: [DiscountStatusEnum!] + timesUsed: IntRangeInput + discountType: [VoucherDiscountType!] + started: DateTimeRangeInput + search: String + metadata: [MetadataFilter!] + ids: [ID!] +} + +enum VoucherDiscountType @doc(category: "Discounts") { + FIXED + PERCENTAGE + SHIPPING +} + +input VoucherSortingInput @doc(category: "Discounts") { + """Specifies the direction in which to sort vouchers.""" + 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! +} + +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 +} + +"""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 +} + +"""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 +} + +type ExportFileCountableConnection { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [ExportFileCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type ExportFileCountableEdge { + """The item at the end of the edge.""" + node: ExportFile! + + """A cursor for use in pagination.""" + cursor: String! +} + +input ExportFileFilterInput { + createdAt: DateTimeRangeInput + updatedAt: DateTimeRangeInput + status: JobStatusEnum + user: String + app: String +} + +input ExportFileSortingInput { + """Specifies the direction in which to sort export file.""" + direction: OrderDirection! + + """Sort export file by the selected field.""" + field: ExportFileSortField! +} + +enum ExportFileSortField { + STATUS + CREATED_AT + UPDATED_AT + LAST_MODIFIED_AT +} + +input CheckoutSortingInput @doc(category: "Checkout") { + """Specifies the direction in which to sort checkouts.""" + direction: OrderDirection! + + """Sort checkouts by the selected field.""" + field: CheckoutSortField! +} + +enum CheckoutSortField @doc(category: "Checkout") { + """Sort checkouts by creation date.""" + CREATION_DATE + + """Sort checkouts by customer.""" + CUSTOMER + + """Sort checkouts by payment.""" + PAYMENT +} + +input CheckoutFilterInput @doc(category: "Checkout") { + customer: String + created: DateRangeInput + search: String + metadata: [MetadataFilter!] + channels: [ID!] + updatedAt: DateRangeInput + authorizeStatus: [CheckoutAuthorizeStatusEnum!] + chargeStatus: [CheckoutChargeStatusEnum!] +} + +type CheckoutLineCountableConnection @doc(category: "Checkout") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [CheckoutLineCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type CheckoutLineCountableEdge @doc(category: "Checkout") { + """The item at the end of the edge.""" + node: CheckoutLine! + + """A cursor for use in pagination.""" + cursor: String! +} + +input AttributeSortingInput @doc(category: "Attributes") { + """Specifies the direction in which to sort attributes.""" + direction: OrderDirection! + + """Sort attributes by the selected field.""" + field: AttributeSortField! +} + +enum AttributeSortField @doc(category: "Attributes") { + """Sort attributes by name""" + NAME + + """Sort attributes by slug""" + SLUG + + """Sort attributes by the value required flag""" + VALUE_REQUIRED + + """Sort attributes by the variant only flag""" + IS_VARIANT_ONLY + + """Sort attributes by visibility in the storefront""" + VISIBLE_IN_STOREFRONT + + """Sort attributes by the filterable in storefront flag""" + FILTERABLE_IN_STOREFRONT + + """Sort attributes by the filterable in dashboard flag""" + FILTERABLE_IN_DASHBOARD + + """Sort attributes by their position in storefront""" + STOREFRONT_SEARCH_POSITION + + """ + Sort attributes based on whether they can be displayed or not in a product grid. + """ + AVAILABLE_IN_GRID +} + +"""Represents ongoing installation of app.""" +type AppInstallation implements Node & Job @doc(category: "Apps") { + 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! + + """ + App's brand data. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + brand: AppBrand +} + +type AppCountableConnection @doc(category: "Apps") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [AppCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type AppCountableEdge @doc(category: "Apps") { + """The item at the end of the edge.""" + node: App! + + """A cursor for use in pagination.""" + cursor: String! +} + +input AppFilterInput @doc(category: "Apps") { + search: String + isActive: Boolean + type: AppTypeEnum +} + +input AppSortingInput @doc(category: "Apps") { + """Specifies the direction in which to sort apps.""" + direction: OrderDirection! + + """Sort apps by the selected field.""" + field: AppSortField! +} + +enum AppSortField @doc(category: "Apps") { + """Sort apps by name.""" + NAME + + """Sort apps by creation date.""" + CREATION_DATE +} + +type AppExtensionCountableConnection @doc(category: "Apps") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [AppExtensionCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type AppExtensionCountableEdge @doc(category: "Apps") { + """The item at the end of the edge.""" + node: AppExtension! + + """A cursor for use in pagination.""" + cursor: String! +} + +input AppExtensionFilterInput @doc(category: "Apps") { + mount: [AppExtensionMountEnum!] + target: AppExtensionTargetEnum +} + +"""Represents address validation rules for a country.""" +type AddressValidationData @doc(category: "Users") { + countryCode: String! + countryName: String! + addressFormat: String! + addressLatinFormat: String! + allowedFields: [String!]! + requiredFields: [String!]! + upperFields: [String!]! + countryAreaType: String! + countryAreaChoices: [ChoiceValue!]! + cityType: String! + cityChoices: [ChoiceValue!]! + cityAreaType: String! + cityAreaChoices: [ChoiceValue!]! + postalCodeType: String! + postalCodeMatchers: [String!]! + postalCodeExamples: [String!]! + postalCodePrefix: String! +} + +type ChoiceValue { + raw: String + verbose: String +} + +type UserCountableConnection @doc(category: "Users") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [UserCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type UserCountableEdge @doc(category: "Users") { + """The item at the end of the edge.""" + node: User! + + """A cursor for use in pagination.""" + cursor: String! +} + +input CustomerFilterInput @doc(category: "Users") { + dateJoined: DateRangeInput + numberOfOrders: IntRangeInput + placedOrders: DateRangeInput + search: String + metadata: [MetadataFilter!] + + """ + Filter by ids. + + Added in Saleor 3.8. + """ + ids: [ID!] + updatedAt: DateTimeRangeInput +} + +input UserSortingInput @doc(category: "Users") { + """Specifies the direction in which to sort users.""" + direction: OrderDirection! + + """Sort users by the selected field.""" + field: UserSortField! +} + +enum UserSortField @doc(category: "Users") { + """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 +} + +type GroupCountableConnection @doc(category: "Users") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [GroupCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type GroupCountableEdge @doc(category: "Users") { + """The item at the end of the edge.""" + node: Group! + + """A cursor for use in pagination.""" + cursor: String! +} + +input PermissionGroupFilterInput @doc(category: "Users") { + search: String + ids: [ID!] +} + +input PermissionGroupSortingInput @doc(category: "Users") { + """Specifies the direction in which to sort permission group.""" + direction: OrderDirection! + + """Sort permission group by the selected field.""" + field: PermissionGroupSortField! +} + +"""Sorting options for permission groups.""" +enum PermissionGroupSortField @doc(category: "Users") { + """Sort permission group accounts by name.""" + NAME +} + +input StaffUserInput @doc(category: "Users") { + status: StaffMemberStatus + search: String + ids: [ID!] +} + +"""Represents status of a staff account.""" +enum StaffMemberStatus @doc(category: "Users") { + """User account has been activated.""" + ACTIVE + + """User account has not been activated yet.""" + DEACTIVATED +} + +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 @doc(category: "Webhooks") + + """ + Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. + + Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. + """ + webhookDelete( + """ID of a webhook to delete.""" + id: ID! + ): WebhookDelete @doc(category: "Webhooks") + + """ + Updates a webhook subscription. + + Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. + """ + webhookUpdate( + """ID of a webhook to update.""" + id: ID! + + """Fields required to update a webhook.""" + input: WebhookUpdateInput! + ): WebhookUpdate @doc(category: "Webhooks") + + """ + Retries event delivery. + + Requires one of the following permissions: MANAGE_APPS. + """ + eventDeliveryRetry( + """ID of the event delivery to retry.""" + id: ID! + ): EventDeliveryRetry @doc(category: "Webhooks") + + """ + Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. + + Added in Saleor 3.11. + + 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. + """ + webhookDryRun( + """The ID of an object to serialize.""" + objectId: ID! + + """The subscription query that defines the webhook event and its payload.""" + query: String! + ): WebhookDryRun @doc(category: "Webhooks") + + """ + Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. + + Added in Saleor 3.11. + + 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. + """ + webhookTrigger( + """The ID of an object to serialize.""" + objectId: ID! + + """The ID of the webhook.""" + webhookId: ID! + ): WebhookTrigger @doc(category: "Webhooks") + + """ + Creates new warehouse. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + createWarehouse( + """Fields required to create warehouse.""" + input: WarehouseCreateInput! + ): WarehouseCreate @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Deletes selected warehouse. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + deleteWarehouse( + """ID of a warehouse to delete.""" + id: ID! + ): WarehouseDelete @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Create a tax class. + + Added in Saleor 3.9. + + Requires one of the following permissions: MANAGE_TAXES. + """ + taxClassCreate( + """Fields required to create a tax class.""" + input: TaxClassCreateInput! + ): TaxClassCreate @doc(category: "Taxes") + + """ + 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. + + Requires one of the following permissions: MANAGE_TAXES. + """ + taxClassDelete( + """ID of a tax class to delete.""" + id: ID! + ): TaxClassDelete @doc(category: "Taxes") + + """ + Update a tax class. + + Added in Saleor 3.9. + + 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 @doc(category: "Taxes") + + """ + Update tax configuration for a channel. + + Added in Saleor 3.9. + + 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 @doc(category: "Taxes") + + """ + Update tax class rates for a specific country. + + Added in Saleor 3.9. + + 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 @doc(category: "Taxes") + + """ + Remove all tax class rates for a specific country. + + Added in Saleor 3.9. + + Requires one of the following permissions: MANAGE_TAXES. + """ + taxCountryConfigurationDelete( + """Country in which to update the tax class rates.""" + countryCode: CountryCode! + ): TaxCountryConfigurationDelete @doc(category: "Taxes") + + """ + 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. + + 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 @doc(category: "Taxes") + + """ + Updates stocks for a given variant and warehouse. + + Added in Saleor 3.13. + + 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. + """ + stockBulkUpdate( + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" + errorPolicy: ErrorPolicyEnum + + """Input list of stocks to update.""" + stocks: [StockBulkUpdateInput!]! + ): StockBulkUpdate @doc(category: "Products") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + Delete staff notification recipient. + + Requires one of the following permissions: MANAGE_SETTINGS. + """ + staffNotificationRecipientDelete( + """ID of a staff notification recipient to delete.""" + id: ID! + ): StaffNotificationRecipientDelete @doc(category: "Users") + + """ + Updates site domain of the shop. + + Requires one of the following permissions: MANAGE_SETTINGS. + """ + shopDomainUpdate( + """Fields required to update site.""" + input: SiteDomainInput + ): ShopDomainUpdate @doc(category: "Shop") + + """ + Updates shop settings. + + Requires one of the following permissions: MANAGE_SETTINGS. + """ + shopSettingsUpdate( + """Fields required to update shop settings.""" + input: ShopSettingsInput! + ): ShopSettingsUpdate @doc(category: "Shop") + + """ + Fetch tax rates. + + Requires one of the following permissions: MANAGE_SETTINGS. + """ + shopFetchTaxRates: ShopFetchTaxRates @doc(category: "Shop") @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 @doc(category: "Shop") + + """ + 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 @doc(category: "Shop") + + """ + Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderSettingsUpdate( + """Fields required to update shop order settings.""" + input: OrderSettingsUpdateInput! + ): OrderSettingsUpdate @doc(category: "Orders") @deprecated(reason: "\\n\\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `channelUpdate` mutation instead.") + + """ + Update gift card settings. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardSettingsUpdate( + """Fields required to update gift card settings.""" + input: GiftCardSettingsUpdateInput! + ): GiftCardSettingsUpdate @doc(category: "Gift cards") + + """ + 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 @doc(category: "Shipping") + + """ + Creates a new shipping price. + + Requires one of the following permissions: MANAGE_SHIPPING. + """ + shippingPriceCreate( + """Fields required to create a shipping price.""" + input: ShippingPriceInput! + ): ShippingPriceCreate @doc(category: "Shipping") + + """ + Deletes a shipping price. + + Requires one of the following permissions: MANAGE_SHIPPING. + """ + shippingPriceDelete( + """ID of a shipping price to delete.""" + id: ID! + ): ShippingPriceDelete @doc(category: "Shipping") + + """ + Deletes shipping prices. + + Requires one of the following permissions: MANAGE_SHIPPING. + """ + shippingPriceBulkDelete( + """List of shipping price IDs to delete.""" + ids: [ID!]! + ): ShippingPriceBulkDelete @doc(category: "Shipping") + + """ + 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 @doc(category: "Shipping") + + """ + 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 @doc(category: "Shipping") + + """ + 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 @doc(category: "Shipping") + + """ + 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 @doc(category: "Shipping") + + """ + Creates a new shipping zone. + + Requires one of the following permissions: MANAGE_SHIPPING. + """ + shippingZoneCreate( + """Fields required to create a shipping zone.""" + input: ShippingZoneCreateInput! + ): ShippingZoneCreate @doc(category: "Shipping") + + """ + Deletes a shipping zone. + + Requires one of the following permissions: MANAGE_SHIPPING. + """ + shippingZoneDelete( + """ID of a shipping zone to delete.""" + id: ID! + ): ShippingZoneDelete @doc(category: "Shipping") + + """ + Deletes shipping zones. + + Requires one of the following permissions: MANAGE_SHIPPING. + """ + shippingZoneBulkDelete( + """List of shipping zone IDs to delete.""" + ids: [ID!]! + ): ShippingZoneBulkDelete @doc(category: "Shipping") + + """ + 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 @doc(category: "Shipping") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Deletes a category. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + categoryDelete( + """ID of a category to delete.""" + id: ID! + ): CategoryDelete @doc(category: "Products") + + """ + Deletes categories. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + categoryBulkDelete( + """List of category IDs to delete.""" + ids: [ID!]! + ): CategoryBulkDelete @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Creates a new collection. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + collectionCreate( + """Fields required to create a collection.""" + input: CollectionCreateInput! + ): CollectionCreate @doc(category: "Products") + + """ + Deletes a collection. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + collectionDelete( + """ID of a collection to delete.""" + id: ID! + ): CollectionDelete @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Deletes collections. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + collectionBulkDelete( + """List of collection IDs to delete.""" + ids: [ID!]! + ): CollectionBulkDelete @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Creates a new product. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productCreate( + """Fields required to create a product.""" + input: ProductCreateInput! + ): ProductCreate @doc(category: "Products") + + """ + Deletes a product. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productDelete( + """ + External ID of a product to delete. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a product to delete.""" + id: ID + ): ProductDelete @doc(category: "Products") + + """ + Creates products. + + Added in Saleor 3.13. + + 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. + """ + productBulkCreate( + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" + errorPolicy: ErrorPolicyEnum + + """Input list of products to create.""" + products: [ProductBulkCreateInput!]! + ): ProductBulkCreate @doc(category: "Products") + + """ + Deletes products. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productBulkDelete( + """List of product IDs to delete.""" + ids: [ID!]! + ): ProductBulkDelete @doc(category: "Products") + + """ + Updates an existing product. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productUpdate( + """ + External ID of a product to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a product to update.""" + id: ID + + """Fields required to update a product.""" + input: ProductInput! + ): ProductUpdate @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Deletes a product media. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productMediaDelete( + """ID of a product media to delete.""" + id: ID! + ): ProductMediaDelete @doc(category: "Products") + + """ + Deletes product media. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productMediaBulkDelete( + """List of product media IDs to delete.""" + ids: [ID!]! + ): ProductMediaBulkDelete @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Deletes a product variant. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productVariantDelete( + """ + External ID of a product variant to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a product variant to delete.""" + id: ID + + """ + SKU of a product variant to delete. + + Added in Saleor 3.8. + """ + sku: String + ): ProductVariantDelete @doc(category: "Products") + + """ + Creates product variants for a given product. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productVariantBulkCreate( + """ + Policies of error handling. DEFAULT: REJECT_EVERYTHING + + Added in Saleor 3.11. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + errorPolicy: ErrorPolicyEnum + + """ID of the product to create the variants for.""" + product: ID! + + """Input list of product variants to create.""" + variants: [ProductVariantBulkCreateInput!]! + ): ProductVariantBulkCreate @doc(category: "Products") + + """ + Update multiple product variants. + + Added in Saleor 3.11. + + 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. + """ + productVariantBulkUpdate( + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" + errorPolicy: ErrorPolicyEnum + + """ID of the product to update the variants for.""" + product: ID! + + """Input list of product variants to update.""" + variants: [ProductVariantBulkUpdateInput!]! + ): ProductVariantBulkUpdate @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Updates an existing variant for product. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productVariantUpdate( + """ + External ID of a product variant to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a product 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Deactivates product variant preorder. It changes all preorder allocation into regular allocation. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + productVariantPreorderDeactivate( + """ID of a variant which preorder should be deactivated.""" + id: ID! + ): ProductVariantPreorderDeactivate @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + 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 @doc(category: "Products") + + """ + Captures the authorized payment amount. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + paymentCapture( + """Transaction amount.""" + amount: PositiveDecimal + + """Payment ID.""" + paymentId: ID! + ): PaymentCapture @doc(category: "Payments") + + """ + Refunds the captured payment amount. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + paymentRefund( + """Transaction amount.""" + amount: PositiveDecimal + + """Payment ID.""" + paymentId: ID! + ): PaymentRefund @doc(category: "Payments") + + """ + Voids the authorized payment. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + paymentVoid( + """Payment ID.""" + paymentId: ID! + ): PaymentVoid @doc(category: "Payments") + + """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 @doc(category: "Payments") + + """Check payment balance.""" + paymentCheckBalance( + """Fields required to check payment balance.""" + input: PaymentCheckBalanceInput! + ): PaymentCheckBalance @doc(category: "Payments") + + """ + Create transaction for checkout or order. + + 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. + """ + 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 @doc(category: "Payments") + + """ + Update transaction. + + Added in Saleor 3.4. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. + """ + 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 @doc(category: "Payments") + + """ + 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. + """ + 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 @doc(category: "Payments") + + """ + Report the event for the transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. + """ + transactionEventReport( + """The amount of the event to report.""" + amount: PositiveDecimal! + + """List of all possible actions for the transaction""" + availableActions: [TransactionActionEnum!] + + """ + The url that will allow to redirect user to payment provider page with event details. + """ + externalUrl: String + + """The ID of the transaction.""" + id: ID! + + """The message related to the event.""" + message: String + + """PSP Reference of the event to report.""" + pspReference: String! + + """ + The time of the event to report. If not provide, the current time will be used. + """ + time: DateTime + + """Current status of the event to report.""" + type: TransactionEventTypeEnum! + ): TransactionEventReport @doc(category: "Payments") + + """ + Initializes a payment gateway session. It triggers the webhook `PAYMENT_GATEWAY_INITIALIZE_SESSION`, to the requested `paymentGateways`. If `paymentGateways` is not provided, the webhook will be send to all subscribed payment gateways. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + paymentGatewayInitialize( + """ + The amount requested for initializing the payment gateway. If not provided, the difference between checkout.total - transactions that are already processed will be send. + """ + amount: PositiveDecimal + + """The ID of the checkout or order.""" + id: ID! + + """List of payment gateways to initialize.""" + paymentGateways: [PaymentGatewayToInitialize!] + ): PaymentGatewayInitialize @doc(category: "Payments") + + """ + Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + transactionInitialize( + """ + The expected action called for the transaction. By default, the `channel.defaultTransactionFlowStrategy` will be used. The field can be used only by app that has `HANDLE_PAYMENTS` permission. + """ + action: TransactionFlowStrategyEnum + + """ + The amount requested for initializing the payment gateway. If not provided, the difference between checkout.total - transactions that are already processed will be send. + """ + amount: PositiveDecimal + + """The ID of the checkout or order.""" + id: ID! + + """Payment gateway used to initialize the transaction.""" + paymentGateway: PaymentGatewayToInitialize! + ): TransactionInitialize @doc(category: "Payments") + + """ + Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + transactionProcess( + """The data that will be passed to the payment gateway.""" + data: JSON + + """The ID of the transaction to process.""" + id: ID! + ): TransactionProcess @doc(category: "Payments") + + """ + Creates a new page. + + Requires one of the following permissions: MANAGE_PAGES. + """ + pageCreate( + """Fields required to create a page.""" + input: PageCreateInput! + ): PageCreate @doc(category: "Pages") + + """ + Deletes a page. + + Requires one of the following permissions: MANAGE_PAGES. + """ + pageDelete( + """ID of a page to delete.""" + id: ID! + ): PageDelete @doc(category: "Pages") + + """ + Deletes pages. + + Requires one of the following permissions: MANAGE_PAGES. + """ + pageBulkDelete( + """List of page IDs to delete.""" + ids: [ID!]! + ): PageBulkDelete @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + 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 @doc(category: "Pages") + + """ + Completes creating an order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + draftOrderComplete( + """ID of the order that will be completed.""" + id: ID! + ): DraftOrderComplete @doc(category: "Orders") + + """ + Creates a new draft order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + draftOrderCreate( + """Fields required to create an order.""" + input: DraftOrderCreateInput! + ): DraftOrderCreate @doc(category: "Orders") + + """ + Deletes a draft order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + draftOrderDelete( + """ + External ID of a product to delete. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a product to delete.""" + id: ID + ): DraftOrderDelete @doc(category: "Orders") + + """ + Deletes draft orders. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + draftOrderBulkDelete( + """List of draft order IDs to delete.""" + ids: [ID!]! + ): DraftOrderBulkDelete @doc(category: "Orders") + + """ + Deletes order lines. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + draftOrderLinesBulkDelete( + """List of order lines IDs to delete.""" + ids: [ID!]! + ): DraftOrderLinesBulkDelete @doc(category: "Orders") @deprecated(reason: "This field will be removed in Saleor 4.0.") + + """ + Updates a draft order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + draftOrderUpdate( + """ + External ID of a draft order to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a draft order to update.""" + id: ID + + """Fields required to update an order.""" + input: DraftOrderInput! + ): DraftOrderUpdate @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + Cancel an order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderCancel( + """ID of the order to cancel.""" + id: ID! + ): OrderCancel @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + Adds granted refund to the order. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderGrantRefundCreate( + """ID of the order.""" + id: ID! + + """Fields required to create a granted refund for the order.""" + input: OrderGrantRefundCreateInput! + ): OrderGrantRefundCreate @doc(category: "Orders") + + """ + Updates granted refund. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderGrantRefundUpdate( + """ID of the granted refund.""" + id: ID! + + """Fields required to update a granted refund.""" + input: OrderGrantRefundUpdateInput! + ): OrderGrantRefundUpdate @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + Remove discount from the order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderDiscountDelete( + """ID of a discount to remove.""" + discountId: ID! + ): OrderDiscountDelete @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + Updates an order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderUpdate( + """ + External ID of an order to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of an order to update.""" + id: ID + + """Fields required to update an order.""" + input: OrderUpdateInput! + ): OrderUpdate @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + Void an order. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderVoid( + """ID of the order to void.""" + id: ID! + ): OrderVoid @doc(category: "Orders") + + """ + Cancels orders. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + orderBulkCancel( + """List of orders IDs to cancel.""" + ids: [ID!]! + ): OrderBulkCancel @doc(category: "Orders") + + """ + Creates multiple orders. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_ORDERS_IMPORT. + """ + orderBulkCreate( + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" + errorPolicy: ErrorPolicyEnum + + """Input list of orders to create. Orders limit: 50.""" + orders: [OrderBulkCreateInput!]! + + """ + Determine how stock should be updated, while processing the order. DEFAULT: UPDATE - Only do update, if there is enough stocks. + """ + stockUpdatePolicy: StockUpdatePolicyEnum + ): OrderBulkCreate @doc(category: "Orders") + + """ + 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 @doc(category: "Menu") + + """ + Creates a new Menu. + + Requires one of the following permissions: MANAGE_MENUS. + """ + menuCreate( + """Fields required to create a menu.""" + input: MenuCreateInput! + ): MenuCreate @doc(category: "Menu") + + """ + Deletes a menu. + + Requires one of the following permissions: MANAGE_MENUS. + """ + menuDelete( + """ID of a menu to delete.""" + id: ID! + ): MenuDelete @doc(category: "Menu") + + """ + Deletes menus. + + Requires one of the following permissions: MANAGE_MENUS. + """ + menuBulkDelete( + """List of menu IDs to delete.""" + ids: [ID!]! + ): MenuBulkDelete @doc(category: "Menu") + + """ + 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 @doc(category: "Menu") + + """ + 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 @doc(category: "Menu") + + """ + Deletes a menu item. + + Requires one of the following permissions: MANAGE_MENUS. + """ + menuItemDelete( + """ID of a menu item to delete.""" + id: ID! + ): MenuItemDelete @doc(category: "Menu") + + """ + Deletes menu items. + + Requires one of the following permissions: MANAGE_MENUS. + """ + menuItemBulkDelete( + """List of menu item IDs to delete.""" + ids: [ID!]! + ): MenuItemBulkDelete @doc(category: "Menu") + + """ + 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 @doc(category: "Menu") + + """ + 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 @doc(category: "Menu") + + """ + 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 @doc(category: "Menu") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + Deletes an invoice. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + invoiceDelete( + """ID of an invoice to delete.""" + id: ID! + ): InvoiceDelete @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + 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 @doc(category: "Orders") + + """ + Activate a gift card. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardActivate( + """ID of a gift card to activate.""" + id: ID! + ): GiftCardActivate @doc(category: "Gift cards") + + """ + 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 @doc(category: "Gift cards") + + """ + Delete gift card. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardDelete( + """ID of the gift card to delete.""" + id: ID! + ): GiftCardDelete @doc(category: "Gift cards") + + """ + Deactivate a gift card. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardDeactivate( + """ID of a gift card to deactivate.""" + id: ID! + ): GiftCardDeactivate @doc(category: "Gift cards") + + """ + 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 @doc(category: "Gift cards") + + """ + Resend a gift card. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardResend( + """Fields required to resend a gift card.""" + input: GiftCardResendInput! + ): GiftCardResend @doc(category: "Gift cards") + + """ + Adds note to the gift card. + + Added in Saleor 3.1. + + 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 @doc(category: "Gift cards") + + """ + Create gift cards. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardBulkCreate( + """Fields required to create gift cards.""" + input: GiftCardBulkCreateInput! + ): GiftCardBulkCreate @doc(category: "Gift cards") + + """ + Delete gift cards. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardBulkDelete( + """List of gift card IDs to delete.""" + ids: [ID!]! + ): GiftCardBulkDelete @doc(category: "Gift cards") + + """ + Activate gift cards. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardBulkActivate( + """List of gift card IDs to activate.""" + ids: [ID!]! + ): GiftCardBulkActivate @doc(category: "Gift cards") + + """ + Deactivate gift cards. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + giftCardBulkDeactivate( + """List of gift card IDs to deactivate.""" + ids: [ID!]! + ): GiftCardBulkDeactivate @doc(category: "Gift cards") + + """ + 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 @doc(category: "Discounts") + + """ + Deletes a sale. + + Requires one of the following permissions: MANAGE_DISCOUNTS. + """ + saleDelete( + """ID of a sale to delete.""" + id: ID! + ): SaleDelete @doc(category: "Discounts") + + """ + Deletes sales. + + Requires one of the following permissions: MANAGE_DISCOUNTS. + """ + saleBulkDelete( + """List of sale IDs to delete.""" + ids: [ID!]! + ): SaleBulkDelete @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + Creates a new voucher. + + Requires one of the following permissions: MANAGE_DISCOUNTS. + """ + voucherCreate( + """Fields required to create a voucher.""" + input: VoucherInput! + ): VoucherCreate @doc(category: "Discounts") + + """ + Deletes a voucher. + + Requires one of the following permissions: MANAGE_DISCOUNTS. + """ + voucherDelete( + """ID of a voucher to delete.""" + id: ID! + ): VoucherDelete @doc(category: "Discounts") + + """ + Deletes vouchers. + + Requires one of the following permissions: MANAGE_DISCOUNTS. + """ + voucherBulkDelete( + """List of voucher IDs to delete.""" + ids: [ID!]! + ): VoucherBulkDelete @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + 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 @doc(category: "Discounts") + + """ + Export products to csv file. + + Requires one of the following permissions: MANAGE_PRODUCTS. + """ + exportProducts( + """Fields required to export product data.""" + input: ExportProductsInput! + ): ExportProducts @doc(category: "Products") + + """ + Export gift cards to csv file. + + Added in Saleor 3.1. + + Requires one of the following permissions: MANAGE_GIFT_CARD. + """ + exportGiftCards( + """Fields required to export gift cards data.""" + input: ExportGiftCardsInput! + ): ExportGiftCards @doc(category: "Gift cards") + + """ + 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 @doc(category: "Checkout") + + """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. + """ + validationRules: CheckoutAddressValidationRules + ): CheckoutBillingAddressUpdate @doc(category: "Checkout") + + """ + 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 @doc(category: "Checkout") + + """Create a new checkout.""" + checkoutCreate( + """Fields required to create checkout.""" + input: CheckoutCreateInput! + ): CheckoutCreate @doc(category: "Checkout") + + """ + Create new checkout from existing order. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + checkoutCreateFromOrder( + """ID of a order that will be used to create the checkout.""" + id: ID! + ): CheckoutCreateFromOrder @doc(category: "Checkout") + + """ + 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 @doc(category: "Checkout") + + """ + 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 @doc(category: "Checkout") + + """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 @doc(category: "Checkout") + + """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 @doc(category: "Checkout") @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 @doc(category: "Checkout") + + """ + 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 @doc(category: "Checkout") + + """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 @doc(category: "Checkout") + + """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 @doc(category: "Checkout") + + """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 @doc(category: "Checkout") + + """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. + """ + validationRules: CheckoutAddressValidationRules + ): CheckoutShippingAddressUpdate @doc(category: "Checkout") + + """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 @doc(category: "Checkout") @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. + """ + 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 @doc(category: "Checkout") + + """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 @doc(category: "Checkout") + + """ + Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. + + Added in Saleor 3.2. + """ + 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 @doc(category: "Checkout") + + """ + Creates new channel. + + Requires one of the following permissions: MANAGE_CHANNELS. + """ + channelCreate( + """Fields required to create channel.""" + input: ChannelCreateInput! + ): ChannelCreate @doc(category: "Channels") + + """ + Update a channel. + + Requires one of the following permissions: MANAGE_CHANNELS. + Requires one of the following permissions when updating only orderSettings field: MANAGE_CHANNELS, MANAGE_ORDERS. + """ + channelUpdate( + """ID of a channel to update.""" + id: ID! + + """Fields required to update a channel.""" + input: ChannelUpdateInput! + ): ChannelUpdate @doc(category: "Channels") + + """ + 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 @doc(category: "Channels") + + """ + Activate a channel. + + Requires one of the following permissions: MANAGE_CHANNELS. + """ + channelActivate( + """ID of the channel to activate.""" + id: ID! + ): ChannelActivate @doc(category: "Channels") + + """ + Deactivate a channel. + + Requires one of the following permissions: MANAGE_CHANNELS. + """ + channelDeactivate( + """ID of the channel to deactivate.""" + id: ID! + ): ChannelDeactivate @doc(category: "Channels") + + """ + Reorder the warehouses of a channel. + + Added in Saleor 3.7. + + 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 @doc(category: "Channels") + + """Creates an attribute.""" + attributeCreate( + """Fields required to create an attribute.""" + input: AttributeCreateInput! + ): AttributeCreate @doc(category: "Attributes") + + """ + Deletes an attribute. + + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. + """ + attributeDelete( + """ + External ID of an attribute to delete. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of an attribute to delete.""" + id: ID + ): AttributeDelete @doc(category: "Attributes") + + """ + Updates attribute. + + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. + """ + attributeUpdate( + """ + External ID of an attribute to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of an attribute to update.""" + id: ID + + """Fields required to update an attribute.""" + input: AttributeUpdateInput! + ): AttributeUpdate @doc(category: "Attributes") + + """ + 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 @doc(category: "Attributes") + + """ + Creates/updates translations for attributes. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_TRANSLATIONS. + """ + attributeBulkTranslate( + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" + errorPolicy: ErrorPolicyEnum + + """List of attributes translations.""" + translations: [AttributeBulkTranslateInput!]! + ): AttributeBulkTranslate @doc(category: "Attributes") + + """ + Deletes attributes. + + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. + """ + attributeBulkDelete( + """List of attribute IDs to delete.""" + ids: [ID!]! + ): AttributeBulkDelete @doc(category: "Attributes") + + """ + 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 @doc(category: "Attributes") + + """ + 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 @doc(category: "Attributes") + + """ + Deletes a value of an attribute. + + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. + """ + attributeValueDelete( + """ + External ID of a value to delete. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a value to delete.""" + id: ID + ): AttributeValueDelete @doc(category: "Attributes") + + """ + Updates value of an attribute. + + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. + """ + attributeValueUpdate( + """ + External ID of an AttributeValue to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of an AttributeValue to update.""" + id: ID + + """Fields required to update an AttributeValue.""" + input: AttributeValueUpdateInput! + ): AttributeValueUpdate @doc(category: "Attributes") + + """ + Creates/updates translations for attributes values. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + + Requires one of the following permissions: MANAGE_TRANSLATIONS. + """ + attributeValueBulkTranslate( + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" + errorPolicy: ErrorPolicyEnum + + """List of attribute values translations.""" + translations: [AttributeValueBulkTranslateInput!]! + ): AttributeValueBulkTranslate @doc(category: "Attributes") + + """ + 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 @doc(category: "Attributes") + + """ + 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 @doc(category: "Attributes") + + """ + 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 @doc(category: "Apps") + + """ + 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 @doc(category: "Apps") + + """ + Deletes an app. + + Requires one of the following permissions: MANAGE_APPS. + """ + appDelete( + """ID of an app to delete.""" + id: ID! + ): AppDelete @doc(category: "Apps") + + """ + Creates a new token. + + Requires one of the following permissions: MANAGE_APPS. + """ + appTokenCreate( + """Fields required to create a new auth token.""" + input: AppTokenInput! + ): AppTokenCreate @doc(category: "Apps") + + """ + 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 @doc(category: "Apps") + + """Verify provided app token.""" + appTokenVerify( + """App token to verify.""" + token: String! + ): AppTokenVerify @doc(category: "Apps") + + """ + 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 @doc(category: "Apps") + + """ + 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 @doc(category: "Apps") + + """ + Delete failed installation. + + Requires one of the following permissions: MANAGE_APPS. + """ + appDeleteFailedInstallation( + """ID of failed installation to delete.""" + id: ID! + ): AppDeleteFailedInstallation @doc(category: "Apps") + + """ + Fetch and validate manifest. + + Requires one of the following permissions: MANAGE_APPS. + """ + appFetchManifest(manifestUrl: String!): AppFetchManifest @doc(category: "Apps") + + """ + Activate the app. + + Requires one of the following permissions: MANAGE_APPS. + """ + appActivate( + """ID of app to activate.""" + id: ID! + ): AppActivate @doc(category: "Apps") + + """ + Deactivate the app. + + Requires one of the following permissions: MANAGE_APPS. + """ + appDeactivate( + """ID of app to deactivate.""" + id: ID! + ): AppDeactivate @doc(category: "Apps") + + """Create JWT token.""" + tokenCreate( + """ + The audience that will be included to JWT tokens with prefix `custom:`. + + Added in Saleor 3.8. + """ + audience: String + + """Email of a user.""" + email: String! + + """Password of a user.""" + password: String! + ): CreateToken @doc(category: "Authentication") + + """ + 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 @doc(category: "Authentication") + + """Verify JWT token.""" + tokenVerify( + """JWT token to validate.""" + token: String! + ): VerifyToken @doc(category: "Authentication") + + """ + Deactivate all JWT tokens of the currently authenticated user. + + Requires one of the following permissions: AUTHENTICATED_USER. + """ + tokensDeactivateAll: DeactivateAllUserTokens @doc(category: "Authentication") + + """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 @doc(category: "Authentication") + + """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 @doc(category: "Authentication") + + """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 @doc(category: "Authentication") + + """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 @doc(category: "Authentication") + + """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 @doc(category: "Authentication") + + """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 @doc(category: "Users") + + """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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """Register a new user.""" + accountRegister( + """Fields required to create a user.""" + input: AccountRegisterInput! + ): AccountRegister @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + Deletes an address. + + Requires one of the following permissions: MANAGE_USERS. + """ + addressDelete( + """ID of the address to delete.""" + id: ID! + ): AddressDelete @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + Creates a new customer. + + Requires one of the following permissions: MANAGE_USERS. + """ + customerCreate( + """Fields required to create a customer.""" + input: UserCreateInput! + ): CustomerCreate @doc(category: "Users") + + """ + Updates an existing customer. + + Requires one of the following permissions: MANAGE_USERS. + """ + customerUpdate( + """ + External ID of a customer to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a customer to update.""" + id: ID + + """Fields required to update a customer.""" + input: CustomerInput! + ): CustomerUpdate @doc(category: "Users") + + """ + Deletes a customer. + + Requires one of the following permissions: MANAGE_USERS. + """ + customerDelete( + """ + External ID of a customer to update. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of a customer to delete.""" + id: ID + ): CustomerDelete @doc(category: "Users") + + """ + Deletes customers. + + Requires one of the following permissions: MANAGE_USERS. + """ + customerBulkDelete( + """List of user IDs to delete.""" + ids: [ID!]! + ): CustomerBulkDelete @doc(category: "Users") + + """ + Updates customers. + + Added in Saleor 3.13. + + 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. + """ + customerBulkUpdate( + """Input list of customers to update.""" + customers: [CustomerBulkUpdateInput!]! + + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" + errorPolicy: ErrorPolicyEnum + ): CustomerBulkUpdate @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + Deletes a user avatar. Only for staff members. + + Requires one of the following permissions: AUTHENTICATED_STAFF_USER. + """ + userAvatarDelete: UserAvatarDelete @doc(category: "Users") + + """ + Activate or deactivate users. + + Requires one of the following permissions: MANAGE_USERS. + """ + userBulkSetActive( + """List of user IDs to activate/deactivate.""" + ids: [ID!]! + + """Determine if users will be set active or not.""" + isActive: Boolean! + ): UserBulkSetActive @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") + + """ + 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 @doc(category: "Users") +} + +""" +Creates a new webhook subscription. + +Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. +""" +type WebhookCreate @doc(category: "Webhooks") { + webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [WebhookError!]! + webhook: Webhook +} + +type WebhookError @doc(category: "Webhooks") { + """ + 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 @doc(category: "Webhooks") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + DELETE_FAILED + SYNTAX + MISSING_SUBSCRIPTION + UNABLE_TO_PARSE + MISSING_EVENT + INVALID_CUSTOM_HEADERS +} + +input WebhookCreateInput @doc(category: "Webhooks") { + """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. + """ + query: String + + """ + Custom headers, which will be added to HTTP request. There is a limitation of 5 headers per webhook and 998 characters per header.Only "X-*" and "Authorization*" keys are allowed. + + Added in Saleor 3.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + customHeaders: JSONString +} + +""" +Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. + +Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. +""" +type WebhookDelete @doc(category: "Webhooks") { + webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [WebhookError!]! + webhook: Webhook +} + +""" +Updates a webhook subscription. + +Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. +""" +type WebhookUpdate @doc(category: "Webhooks") { + webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [WebhookError!]! + webhook: Webhook +} + +input WebhookUpdateInput @doc(category: "Webhooks") { + """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. + """ + query: String + + """ + Custom headers, which will be added to HTTP request. There is a limitation of 5 headers per webhook and 998 characters per header.Only "X-*" and "Authorization*" keys are allowed. + + Added in Saleor 3.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + customHeaders: JSONString +} + +""" +Retries event delivery. + +Requires one of the following permissions: MANAGE_APPS. +""" +type EventDeliveryRetry @doc(category: "Webhooks") { + """Event delivery.""" + delivery: EventDelivery + errors: [WebhookError!]! +} + +""" +Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. + +Added in Saleor 3.11. + +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. +""" +type WebhookDryRun @doc(category: "Webhooks") { + """JSON payload, that would be sent out to webhook's target URL.""" + payload: JSONString + errors: [WebhookDryRunError!]! +} + +type WebhookDryRunError @doc(category: "Webhooks") { + """ + 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: WebhookDryRunErrorCode! +} + +"""An enumeration.""" +enum WebhookDryRunErrorCode @doc(category: "Webhooks") { + GRAPHQL_ERROR + NOT_FOUND + INVALID_ID + MISSING_PERMISSION + TYPE_NOT_SUPPORTED + SYNTAX + MISSING_SUBSCRIPTION + UNABLE_TO_PARSE + MISSING_EVENT +} + +""" +Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. + +Added in Saleor 3.11. + +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. +""" +type WebhookTrigger @doc(category: "Webhooks") { + delivery: EventDelivery + errors: [WebhookTriggerError!]! +} + +type WebhookTriggerError @doc(category: "Webhooks") { + """ + 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: WebhookTriggerErrorCode! +} + +"""An enumeration.""" +enum WebhookTriggerErrorCode @doc(category: "Webhooks") { + GRAPHQL_ERROR + NOT_FOUND + INVALID_ID + MISSING_PERMISSION + TYPE_NOT_SUPPORTED + SYNTAX + MISSING_SUBSCRIPTION + UNABLE_TO_PARSE + MISSING_QUERY + MISSING_EVENT +} + +""" +Creates new warehouse. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type WarehouseCreate @doc(category: "Products") { + warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [WarehouseError!]! + warehouse: Warehouse +} + +type WarehouseError @doc(category: "Products") { + """ + 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 @doc(category: "Products") { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +input WarehouseCreateInput @doc(category: "Products") { + """Warehouse slug.""" + slug: String + + """The email address of the warehouse.""" + email: String + + """ + External ID of the warehouse. + + Added in Saleor 3.10. + """ + externalReference: 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!] +} + +""" +Updates given warehouse. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type WarehouseUpdate @doc(category: "Products") { + warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [WarehouseError!]! + warehouse: Warehouse +} + +input WarehouseUpdateInput @doc(category: "Products") { + """Warehouse slug.""" + slug: String + + """The email address of the warehouse.""" + email: String + + """ + External ID of the warehouse. + + Added in Saleor 3.10. + """ + externalReference: String + + """Warehouse name.""" + name: String + + """Address of the warehouse.""" + address: AddressInput + + """ + Click and collect options: local, all or disabled. + + Added in Saleor 3.1. + """ + clickAndCollectOption: WarehouseClickAndCollectOptionEnum + + """ + Visibility of warehouse stocks. + + Added in Saleor 3.1. + """ + isPrivate: Boolean +} + +""" +Deletes selected warehouse. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type WarehouseDelete @doc(category: "Products") { + warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [WarehouseError!]! + warehouse: Warehouse +} + +""" +Add shipping zone to given warehouse. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type WarehouseShippingZoneAssign @doc(category: "Products") { + 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 @doc(category: "Products") { + warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [WarehouseError!]! + warehouse: Warehouse +} + +""" +Create a tax class. + +Added in Saleor 3.9. + +Requires one of the following permissions: MANAGE_TAXES. +""" +type TaxClassCreate @doc(category: "Taxes") { + errors: [TaxClassCreateError!]! + taxClass: TaxClass +} + +type TaxClassCreateError @doc(category: "Taxes") { + """ + 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 @doc(category: "Taxes") { + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +input TaxClassCreateInput @doc(category: "Taxes") { + """Name of the tax class.""" + name: String! + + """List of country-specific tax rates to create for this tax class.""" + createCountryRates: [CountryRateInput!] +} + +input CountryRateInput @doc(category: "Taxes") { + """Country in which this rate applies.""" + countryCode: CountryCode! + + """ + Tax rate value provided as percentage. Example: provide `23` to represent `23%` tax rate. + """ + rate: Float! +} + +""" +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. + +Requires one of the following permissions: MANAGE_TAXES. +""" +type TaxClassDelete @doc(category: "Taxes") { + errors: [TaxClassDeleteError!]! + taxClass: TaxClass +} + +type TaxClassDeleteError @doc(category: "Taxes") { + """ + 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 @doc(category: "Taxes") { + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +""" +Update a tax class. + +Added in Saleor 3.9. + +Requires one of the following permissions: MANAGE_TAXES. +""" +type TaxClassUpdate @doc(category: "Taxes") { + errors: [TaxClassUpdateError!]! + taxClass: TaxClass +} + +type TaxClassUpdateError @doc(category: "Taxes") { + """ + 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 @doc(category: "Taxes") { + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +input TaxClassUpdateInput @doc(category: "Taxes") { + """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!] +} + +input CountryRateUpdateInput @doc(category: "Taxes") { + """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 +} + +""" +Update tax configuration for a channel. + +Added in Saleor 3.9. + +Requires one of the following permissions: MANAGE_TAXES. +""" +type TaxConfigurationUpdate @doc(category: "Taxes") { + errors: [TaxConfigurationUpdateError!]! + taxConfiguration: TaxConfiguration +} + +type TaxConfigurationUpdateError @doc(category: "Taxes") { + """ + 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 @doc(category: "Taxes") { + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +input TaxConfigurationUpdateInput @doc(category: "Taxes") { + """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!] +} + +input TaxConfigurationPerCountryInput @doc(category: "Taxes") { + """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 class rates for a specific country. + +Added in Saleor 3.9. + +Requires one of the following permissions: MANAGE_TAXES. +""" +type TaxCountryConfigurationUpdate @doc(category: "Taxes") { + """Updated tax class rates grouped by a country.""" + taxCountryConfiguration: TaxCountryConfiguration + errors: [TaxCountryConfigurationUpdateError!]! +} + +type TaxCountryConfigurationUpdateError @doc(category: "Taxes") { + """ + 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 @doc(category: "Taxes") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + ONLY_ONE_DEFAULT_COUNTRY_RATE_ALLOWED + CANNOT_CREATE_NEGATIVE_RATE +} + +input TaxClassRateInput @doc(category: "Taxes") { + """ID of a tax class for which to update the tax rate""" + taxClassId: ID + + """Tax rate value.""" + rate: Float +} + +""" +Remove all tax class rates for a specific country. + +Added in Saleor 3.9. + +Requires one of the following permissions: MANAGE_TAXES. +""" +type TaxCountryConfigurationDelete @doc(category: "Taxes") { + """Updated tax class rates grouped by a country.""" + taxCountryConfiguration: TaxCountryConfiguration + errors: [TaxCountryConfigurationDeleteError!]! +} + +type TaxCountryConfigurationDeleteError @doc(category: "Taxes") { + """ + 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 @doc(category: "Taxes") { + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +""" +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. + +Requires one of the following permissions: MANAGE_TAXES. +""" +type TaxExemptionManage @doc(category: "Taxes") { + taxableObject: TaxSourceObject + errors: [TaxExemptionManageError!]! +} + +union TaxSourceObject = Checkout | Order + +type TaxExemptionManageError @doc(category: "Taxes") { + """ + 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 @doc(category: "Taxes") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + NOT_EDITABLE_ORDER +} + +""" +Updates stocks for a given variant and warehouse. + +Added in Saleor 3.13. + +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 StockBulkUpdate @doc(category: "Products") { + """Returns how many objects were updated.""" + count: Int! + + """List of the updated stocks.""" + results: [StockBulkResult!]! + errors: [StockBulkUpdateError!]! +} + +type StockBulkResult @doc(category: "Products") { + """Stock data.""" + stock: Stock + + """List of errors occurred on create or update attempt.""" + errors: [StockBulkUpdateError!] +} + +type StockBulkUpdateError @doc(category: "Products") { + """ + 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: StockBulkUpdateErrorCode! +} + +"""An enumeration.""" +enum StockBulkUpdateErrorCode @doc(category: "Products") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED +} + +enum ErrorPolicyEnum { + """ + Save what is possible within a single row. If there are errors in an input data row, try to save it partially and skip the invalid part. + """ + IGNORE_FAILED + + """Reject all rows if there is at least one error in any of them.""" + REJECT_EVERYTHING + + """Reject rows with errors.""" + REJECT_FAILED_ROWS +} + +input StockBulkUpdateInput @doc(category: "Products") { + """Variant ID.""" + variantId: ID + + """Variant external reference.""" + variantExternalReference: String + + """Warehouse ID.""" + warehouseId: ID + + """Warehouse external reference.""" + warehouseExternalReference: String + + """Quantity of items available for sell.""" + quantity: Int! +} + +""" +Creates a new staff notification recipient. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type StaffNotificationRecipientCreate @doc(category: "Users") { + shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShopError!]! + staffNotificationRecipient: StaffNotificationRecipient +} + +type ShopError @doc(category: "Shop") { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: ShopErrorCode! +} + +"""An enumeration.""" +enum ShopErrorCode { + ALREADY_EXISTS + CANNOT_FETCH_TAX_RATES + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +input StaffNotificationRecipientInput { + """The ID of the user subscribed to email notifications..""" + user: ID + + """Email address of a user subscribed to email notifications.""" + email: String + + """Determines if a notification active.""" + active: Boolean +} + +""" +Updates a staff notification recipient. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type StaffNotificationRecipientUpdate @doc(category: "Users") { + 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 @doc(category: "Users") { + shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShopError!]! + staffNotificationRecipient: StaffNotificationRecipient +} + +""" +Updates site domain of the shop. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type ShopDomainUpdate @doc(category: "Shop") { + """Updated shop.""" + shop: Shop + shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShopError!]! +} + +input SiteDomainInput { + """Domain name for shop.""" + domain: String + + """Shop site name.""" + name: String +} + +""" +Updates shop settings. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type ShopSettingsUpdate @doc(category: "Shop") { + """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. + """ + limitQuantityPerCheckout: Int + + """ + Enable automatic account confirmation by email. + + Added in Saleor 3.14. + """ + enableAccountConfirmationByEmail: Boolean + + """ + 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 +} + +""" +Fetch tax rates. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type ShopFetchTaxRates @doc(category: "Shop") { + """Updated shop.""" + shop: Shop + shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShopError!]! +} + +""" +Creates/updates translations for shop settings. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type ShopSettingsTranslate @doc(category: "Shop") { + """Updated shop settings.""" + shop: Shop + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! +} + +type TranslationError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: TranslationErrorCode! +} + +"""An enumeration.""" +enum TranslationErrorCode { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED +} + +input ShopSettingsTranslationInput { + headerText: String + description: String +} + +""" +Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type ShopAddressUpdate @doc(category: "Shop") { + """Updated shop.""" + shop: Shop + shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShopError!]! +} + +""" +Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderSettingsUpdate @doc(category: "Orders") { + """Order settings.""" + orderSettings: OrderSettings + orderSettingsErrors: [OrderSettingsError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderSettingsError!]! +} + +type OrderSettingsError @doc(category: "Orders") { + """ + 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 @doc(category: "Orders") { + INVALID +} + +input OrderSettingsUpdateInput @doc(category: "Orders") { + """ + When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. By default set to True + """ + automaticallyConfirmAllNewOrders: Boolean + + """ + When enabled, all non-shippable gift card orders will be fulfilled automatically. By defualt set to True. + """ + automaticallyFulfillNonShippableGiftCard: Boolean +} + +""" +Update gift card settings. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardSettingsUpdate @doc(category: "Gift cards") { + """Gift card settings.""" + giftCardSettings: GiftCardSettings + errors: [GiftCardSettingsError!]! +} + +type GiftCardSettingsError @doc(category: "Gift cards") { + """ + 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 @doc(category: "Gift cards") { + INVALID + REQUIRED + GRAPHQL_ERROR +} + +input GiftCardSettingsUpdateInput @doc(category: "Gift cards") { + """Defines gift card default expiry settings.""" + expiryType: GiftCardSettingsExpiryTypeEnum + + """Defines gift card expiry period.""" + expiryPeriod: TimePeriodInputType +} + +input TimePeriodInputType { + """The length of the period.""" + amount: Int! + + """The type of the period.""" + type: TimePeriodTypeEnum! +} + +""" +Manage shipping method's availability in channels. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingMethodChannelListingUpdate @doc(category: "Shipping") { + """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!]! +} + +type ShippingError @doc(category: "Shipping") { + """ + 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 @doc(category: "Shipping") { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + MAX_LESS_THAN_MIN + NOT_FOUND + REQUIRED + UNIQUE + DUPLICATED_INPUT_ITEM +} + +input ShippingMethodChannelListingInput @doc(category: "Shipping") { + """List of channels to which the shipping method should be assigned.""" + addChannels: [ShippingMethodChannelListingAddInput!] + + """List of channels from which the shipping method should be unassigned.""" + removeChannels: [ID!] +} + +input ShippingMethodChannelListingAddInput @doc(category: "Shipping") { + """ID of a channel.""" + channelId: ID! + + """Shipping price of the shipping method in this channel.""" + price: PositiveDecimal + + """Minimum order price to use this shipping method.""" + minimumOrderPrice: PositiveDecimal + + """Maximum order price to use this shipping method.""" + maximumOrderPrice: PositiveDecimal +} + +""" +Creates a new shipping price. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingPriceCreate @doc(category: "Shipping") { + """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!]! +} + +input ShippingPriceInput @doc(category: "Shipping") { + """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 +} + +scalar WeightScalar + +input ShippingPostalCodeRulesCreateInputRange @doc(category: "Shipping") { + """Start range of the postal code.""" + start: String! + + """End range of the postal code.""" + end: String +} + +""" +Deletes a shipping price. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingPriceDelete @doc(category: "Shipping") { + """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!]! +} + +""" +Deletes shipping prices. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingPriceBulkDelete @doc(category: "Shipping") { + """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!]! +} + +""" +Updates a new shipping price. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingPriceUpdate @doc(category: "Shipping") { + """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!]! +} + +""" +Creates/updates translations for a shipping method. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type ShippingPriceTranslate @doc(category: "Shipping") { + 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 +} + +""" +Exclude products from shipping price. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingPriceExcludeProducts @doc(category: "Shipping") { + """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 @doc(category: "Shipping") { + """List of products which will be excluded.""" + products: [ID!]! +} + +""" +Remove product from excluded list for shipping price. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingPriceRemoveProductFromExclude @doc(category: "Shipping") { + """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 a new shipping zone. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingZoneCreate @doc(category: "Shipping") { + shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShippingError!]! + shippingZone: ShippingZone +} + +input ShippingZoneCreateInput @doc(category: "Shipping") { + """Shipping zone's name. Visible only to the staff.""" + name: String + + """Description of the shipping zone.""" + description: String + + """List of countries in this shipping zone.""" + countries: [String!] + + """ + Default shipping zone will be used for countries not covered by other zones. + """ + default: Boolean + + """List of warehouses to assign to a shipping zone""" + addWarehouses: [ID!] + + """List of channels to assign to the shipping zone.""" + addChannels: [ID!] +} + +""" +Deletes a shipping zone. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingZoneDelete @doc(category: "Shipping") { + shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShippingError!]! + shippingZone: ShippingZone +} + +""" +Deletes shipping zones. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingZoneBulkDelete @doc(category: "Shipping") { + """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!]! +} + +""" +Updates a new shipping zone. + +Requires one of the following permissions: MANAGE_SHIPPING. +""" +type ShippingZoneUpdate @doc(category: "Shipping") { + shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ShippingError!]! + shippingZone: ShippingZone +} + +input ShippingZoneUpdateInput @doc(category: "Shipping") { + """Shipping zone's name. Visible only to the staff.""" + name: String + + """Description of the shipping zone.""" + description: String + + """List of countries in this shipping zone.""" + countries: [String!] + + """ + Default shipping zone will be used for countries not covered by other zones. + """ + default: Boolean + + """List of warehouses to assign to a shipping zone""" + addWarehouses: [ID!] + + """List of channels to assign to the shipping zone.""" + addChannels: [ID!] + + """List of warehouses to unassign from a shipping zone""" + removeWarehouses: [ID!] + + """List of channels to unassign from the shipping zone.""" + removeChannels: [ID!] +} + +""" +Assign attributes to a given product type. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type ProductAttributeAssign @doc(category: "Products") { + """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!]! +} + +type ProductError @doc(category: "Products") { + """ + 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 @doc(category: "Products") { + ALREADY_EXISTS + ATTRIBUTE_ALREADY_ASSIGNED + ATTRIBUTE_CANNOT_BE_ASSIGNED + ATTRIBUTE_VARIANTS_DISABLED + MEDIA_ALREADY_ASSIGNED + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + INVALID_PRICE + 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 +} + +input ProductAttributeAssignInput @doc(category: "Products") { + """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 +} + +enum ProductAttributeType @doc(category: "Products") { + PRODUCT + VARIANT +} + +""" +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 @doc(category: "Products") { + """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 @doc(category: "Products") { + """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! +} + +""" +Un-assign attributes from a given product type. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type ProductAttributeUnassign @doc(category: "Products") { + """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!]! +} + +""" +Creates a new category. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CategoryCreate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + category: Category +} + +input CategoryInput @doc(category: "Products") { + """ + 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!] +} + +input SeoInput { + """SEO title.""" + title: String + + """SEO description.""" + description: String +} + +""" +Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec. +""" +scalar Upload + +input MetadataInput { + """Key of a metadata item.""" + key: String! + + """Value of a metadata item.""" + value: String! +} + +""" +Deletes a category. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CategoryDelete @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + category: Category +} + +""" +Deletes categories. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CategoryBulkDelete @doc(category: "Products") { + """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!]! +} + +""" +Updates a category. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CategoryUpdate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + category: Category +} + +""" +Creates/updates translations for a category. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type CategoryTranslate @doc(category: "Products") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + category: Category +} + +input TranslationInput { + seoTitle: String + seoDescription: String + name: String + + """ + Translated description. + + Rich text format. For reference see https://editorjs.io/ + """ + description: JSONString +} + +""" +Adds products to a collection. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionAddProducts @doc(category: "Products") { + """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!]! +} + +type CollectionError @doc(category: "Products") { + """ + 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 @doc(category: "Products") { + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT +} + +""" +Creates a new collection. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionCreate @doc(category: "Products") { + collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [CollectionError!]! + collection: Collection +} + +input CollectionCreateInput @doc(category: "Products") { + """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!] +} + +""" +Deletes a collection. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionDelete @doc(category: "Products") { + collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [CollectionError!]! + collection: Collection +} + +""" +Reorder the products of a collection. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionReorderProducts @doc(category: "Products") { + """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!]! +} + +input MoveProductInput @doc(category: "Products") { + """The ID of the product to move.""" + productId: ID! + + """ + The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. + """ + sortOrder: Int +} + +""" +Deletes collections. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionBulkDelete @doc(category: "Products") { + """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!]! +} + +""" +Remove products from a collection. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionRemoveProducts @doc(category: "Products") { + """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!]! +} + +""" +Updates a collection. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionUpdate @doc(category: "Products") { + collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [CollectionError!]! + collection: Collection +} + +input CollectionInput @doc(category: "Products") { + """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!] +} + +""" +Creates/updates translations for a collection. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type CollectionTranslate @doc(category: "Products") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + collection: Collection +} + +""" +Manage collection's availability in channels. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type CollectionChannelListingUpdate @doc(category: "Products") { + """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!]! +} + +type CollectionChannelListingError @doc(category: "Products") { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: ProductErrorCode! + + """List of attributes IDs which causes the error.""" + attributes: [ID!] + + """List of attribute values IDs which causes the error.""" + values: [ID!] + + """List of channels IDs which causes the error.""" + channels: [ID!] +} + +input CollectionChannelListingUpdateInput @doc(category: "Products") { + """List of channels to which the collection should be assigned.""" + addChannels: [PublishableChannelListingInput!] + + """List of channels from which the collection should be unassigned.""" + removeChannels: [ID!] +} + +input PublishableChannelListingInput @doc(category: "Products") { + """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 +} + +""" +Creates a new product. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductCreate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + product: Product +} + +input ProductCreateInput @doc(category: "Products") { + """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. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + """ + 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!] + + """ + External ID of this product. + + Added in Saleor 3.10. + """ + externalReference: String + + """ID of the type that product belongs to.""" + productType: ID! +} + +input AttributeValueInput @doc(category: "Attributes") { + """ID of the selected attribute.""" + id: ID + + """ + External ID of this attribute. + + Added in Saleor 3.14. + """ + externalReference: String + + """ + The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. This field will be removed in Saleor 4.0. + """ + values: [String!] + + """ + Attribute value ID or external reference. + + Added in Saleor 3.9. + """ + dropdown: AttributeValueSelectableTypeInput + + """ + Attribute value ID or external reference. + + Added in Saleor 3.9. + """ + swatch: AttributeValueSelectableTypeInput + + """ + List of attribute value IDs or external references. + + Added in Saleor 3.9. + """ + multiselect: [AttributeValueSelectableTypeInput!] + + """ + Numeric value of an attribute. + + Added in Saleor 3.9. + """ + numeric: 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 +} + +""" +Represents attribute value. +1. If ID is provided, then attribute value will be resolved by ID. +2. If externalReference is provided, then attribute value will be resolved by external reference. +3. If value is provided, then attribute value will be resolved by value. If this attribute value doesn't exist, then it will be created. +4. If externalReference and value is provided then new attribute value will be created. + +Added in Saleor 3.9. +""" +input AttributeValueSelectableTypeInput @doc(category: "Attributes") { + """ID of an attribute value.""" + id: ID + + """ + External reference of an attribute value. + + Added in Saleor 3.14. + """ + externalReference: String + + """ + The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. + """ + value: String +} + +""" +Deletes a product. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductDelete @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + product: Product +} + +""" +Creates products. + +Added in Saleor 3.13. + +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 ProductBulkCreate @doc(category: "Products") { + """Returns how many objects were created.""" + count: Int! + + """List of the created products.""" + results: [ProductBulkResult!]! + errors: [ProductBulkCreateError!]! +} + +type ProductBulkResult @doc(category: "Products") { + """Product data.""" + product: Product + + """List of errors occurred on create attempt.""" + errors: [ProductBulkCreateError!] +} + +type ProductBulkCreateError @doc(category: "Products") { + """ + Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + path: String + + """The error message.""" + message: String + + """The error code.""" + code: ProductBulkCreateErrorCode! + + """List of attributes IDs which causes the error.""" + attributes: [ID!] + + """List of attribute values IDs which causes the error.""" + values: [ID!] + + """List of warehouse IDs which causes the error.""" + warehouses: [ID!] + + """List of channel IDs which causes the error.""" + channels: [ID!] +} + +"""An enumeration.""" +enum ProductBulkCreateErrorCode @doc(category: "Products") { + ATTRIBUTE_ALREADY_ASSIGNED + ATTRIBUTE_CANNOT_BE_ASSIGNED + ATTRIBUTE_VARIANTS_DISABLED + BLANK + MAX_LENGTH + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + INVALID_PRICE + PRODUCT_WITHOUT_CATEGORY + NOT_FOUND + REQUIRED + UNIQUE + PRODUCT_NOT_ASSIGNED_TO_CHANNEL + UNSUPPORTED_MEDIA_PROVIDER +} + +input ProductBulkCreateInput @doc(category: "Products") { + """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. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + """ + 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.""" + metadata: [MetadataInput!] + + """Fields required to update the product private metadata.""" + privateMetadata: [MetadataInput!] + + """External ID of this product.""" + externalReference: String + + """ID of the type that product belongs to.""" + productType: ID! + + """List of media inputs associated with the product.""" + media: [MediaInput!] + + """List of channels in which the product is available.""" + channelListings: [ProductChannelListingCreateInput!] + + """Input list of product variants to create.""" + variants: [ProductVariantBulkCreateInput!] +} + +input MediaInput { + """Alt text for a product media.""" + alt: String + + """Represents an image file in a multipart request.""" + image: Upload + + """Represents an URL to an external media.""" + mediaUrl: String +} + +input ProductChannelListingCreateInput @doc(category: "Products") { + """ID of a channel.""" + channelId: ID! + + """Determines if object is visible to customers.""" + isPublished: Boolean + + """Publication date time. ISO 8601 standard.""" + 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 time from which a product will be available for purchase. When not set and `isAvailable` is set to True, the current day is assumed. + """ + availableForPurchaseAt: DateTime +} + +input ProductVariantBulkCreateInput @doc(category: "Products") { + """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. + """ + preorder: PreorderSettingsInput + + """ + Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. + + Added in Saleor 3.1. + """ + 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!] + + """ + External ID of this product variant. + + Added in Saleor 3.10. + """ + externalReference: String + + """Stocks of a product available for sale.""" + stocks: [StockInput!] + + """List of prices assigned to channels.""" + channelListings: [ProductVariantChannelListingAddInput!] +} + +input BulkAttributeValueInput @doc(category: "Products") { + """ID of the selected attribute.""" + id: ID + + """ + External ID of this attribute. + + Added in Saleor 3.14. + """ + externalReference: String + + """ + The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.This field will be removed in Saleor 4.0. + """ + values: [String!] + + """ + Attribute value ID. + + Added in Saleor 3.12. + """ + dropdown: AttributeValueSelectableTypeInput + + """ + Attribute value ID. + + Added in Saleor 3.12. + """ + swatch: AttributeValueSelectableTypeInput + + """ + List of attribute value IDs. + + Added in Saleor 3.12. + """ + multiselect: [AttributeValueSelectableTypeInput!] + + """ + Numeric value of an attribute. + + Added in Saleor 3.12. + """ + numeric: String + + """ + URL of the file attribute. Every time, a new value is created. + + Added in Saleor 3.12. + """ + file: String + + """ + File content type. + + Added in Saleor 3.12. + """ + contentType: String + + """ + List of entity IDs that will be used as references. + + Added in Saleor 3.12. + """ + references: [ID!] + + """ + Text content in JSON format. + + Added in Saleor 3.12. + """ + richText: JSONString + + """ + Plain text content. + + Added in Saleor 3.12. + """ + plainText: String + + """ + The boolean value of an attribute to resolve. If the passed value is non-existent, it will be created. + """ + boolean: Boolean + + """ + Represents the date value of the attribute value. + + Added in Saleor 3.12. + """ + date: Date + + """ + Represents the date/time value of the attribute value. + + Added in Saleor 3.12. + """ + dateTime: DateTime +} + +input PreorderSettingsInput @doc(category: "Products") { + """The global threshold for preorder variant.""" + globalThreshold: Int + + """The end date for preorder.""" + endDate: DateTime +} + +input StockInput @doc(category: "Products") { + """Warehouse in which stock is located.""" + warehouse: ID! + + """Quantity of items available for sell.""" + quantity: Int! +} + +input ProductVariantChannelListingAddInput @doc(category: "Products") { + """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. + """ + preorderThreshold: Int +} + +""" +Deletes products. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductBulkDelete @doc(category: "Products") { + """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!]! +} + +""" +Updates an existing product. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductUpdate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + product: Product +} + +input ProductInput @doc(category: "Products") { + """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. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + """ + 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!] + + """ + External ID of this product. + + Added in Saleor 3.10. + """ + externalReference: String +} + +""" +Creates/updates translations for a product. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type ProductTranslate @doc(category: "Products") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + product: Product +} + +""" +Manage product's availability in channels. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductChannelListingUpdate @doc(category: "Products") { + """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!]! +} + +type ProductChannelListingError @doc(category: "Products") { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: ProductErrorCode! + + """List of attributes IDs which causes the error.""" + attributes: [ID!] + + """List of attribute values IDs which causes the error.""" + values: [ID!] + + """List of channels IDs which causes the error.""" + channels: [ID!] + + """List of variants IDs which causes the error.""" + variants: [ID!] +} + +input ProductChannelListingUpdateInput @doc(category: "Products") { + """List of channels to which the product should be assigned or updated.""" + updateChannels: [ProductChannelListingAddInput!] + + """List of channels from which the product should be unassigned.""" + removeChannels: [ID!] +} + +input ProductChannelListingAddInput @doc(category: "Products") { + """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!] +} + +""" +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 @doc(category: "Products") { + 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 @doc(category: "Products") { + """Alt text for a product media.""" + alt: String + + """Represents an image file in a multipart request.""" + image: Upload + + """ID of an product.""" + product: ID! + + """Represents an URL to an external media.""" + mediaUrl: String +} + +""" +Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantReorder @doc(category: "Products") { + product: Product + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! +} + +input ReorderInput { + """The ID of the item to move.""" + id: ID! + + """ + The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. + """ + sortOrder: Int +} + +""" +Deletes a product media. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductMediaDelete @doc(category: "Products") { + product: Product + media: ProductMedia + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! +} + +""" +Deletes product media. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductMediaBulkDelete @doc(category: "Products") { + """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!]! +} + +""" +Changes ordering of the product media. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductMediaReorder @doc(category: "Products") { + product: Product + media: [ProductMedia!] + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! +} + +""" +Updates a product media. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductMediaUpdate @doc(category: "Products") { + 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 @doc(category: "Products") { + """Alt text for a product media.""" + alt: String +} + +""" +Creates a new product type. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type ProductTypeCreate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + productType: ProductType +} + +input ProductTypeInput @doc(category: "Products") { + """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. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + """ + 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 +} + +""" +Deletes a product type. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type ProductTypeDelete @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + productType: ProductType +} + +""" +Deletes product types. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type ProductTypeBulkDelete @doc(category: "Products") { + """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!]! +} + +""" +Updates an existing product type. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type ProductTypeUpdate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + productType: ProductType +} + +""" +Reorder the attributes of a product type. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type ProductTypeReorderAttributes @doc(category: "Products") { + """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!]! +} + +""" +Reorder product attribute values. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductReorderAttributeValues @doc(category: "Products") { + """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!]! +} + +""" +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 @doc(category: "Products") { + 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 @doc(category: "Products") { + """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! +} + +""" +Remove digital content assigned to given variant. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type DigitalContentDelete @doc(category: "Products") { + variant: ProductVariant + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! +} + +""" +Update digital content. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type DigitalContentUpdate @doc(category: "Products") { + variant: ProductVariant + content: DigitalContent + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! +} + +input DigitalContentInput @doc(category: "Products") { + """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!] +} + +""" +Generate new URL to digital content. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type DigitalContentUrlCreate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + digitalContentUrl: DigitalContentUrl +} + +input DigitalContentUrlCreateInput @doc(category: "Products") { + """Digital content ID which URL will belong to.""" + content: ID! +} + +""" +Creates a new variant for a product. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantCreate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + productVariant: ProductVariant +} + +input ProductVariantCreateInput @doc(category: "Products") { + """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. + """ + preorder: PreorderSettingsInput + + """ + Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. + + Added in Saleor 3.1. + """ + 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!] + + """ + External ID of this product variant. + + Added in Saleor 3.10. + """ + externalReference: String + + """Product ID of which type is the variant.""" + product: ID! + + """Stocks of a product available for sale.""" + stocks: [StockInput!] +} + +""" +Deletes a product variant. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantDelete @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + productVariant: ProductVariant +} + +""" +Creates product variants for a given product. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantBulkCreate @doc(category: "Products") { + """Returns how many objects were created.""" + count: Int! + + """List of the created variants.This field will be removed in Saleor 4.0.""" + productVariants: [ProductVariant!]! + + """ + List of the created variants. + + Added in Saleor 3.11. + """ + results: [ProductVariantBulkResult!]! + bulkProductErrors: [BulkProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [BulkProductError!]! +} + +type ProductVariantBulkResult @doc(category: "Products") { + """Product variant data.""" + productVariant: ProductVariant + + """List of errors occurred on create attempt.""" + errors: [ProductVariantBulkError!] +} + +type ProductVariantBulkError @doc(category: "Products") { + """ + 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: ProductVariantBulkErrorCode! + + """ + Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + + Added in Saleor 3.14. + """ + path: String + + """List of attributes IDs which causes the error.""" + attributes: [ID!] + + """List of attribute values IDs which causes the error.""" + values: [ID!] + + """List of warehouse IDs which causes the error.""" + warehouses: [ID!] + + """ + List of stocks IDs which causes the error. + + Added in Saleor 3.12. + """ + stocks: [ID!] + + """ + List of channel IDs which causes the error. + + Added in Saleor 3.12. + """ + channels: [ID!] + + """List of channel listings IDs which causes the error.""" + channelListings: [ID!] +} + +"""An enumeration.""" +enum ProductVariantBulkErrorCode @doc(category: "Products") { + ATTRIBUTE_ALREADY_ASSIGNED + ATTRIBUTE_CANNOT_BE_ASSIGNED + ATTRIBUTE_VARIANTS_DISABLED + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + INVALID_PRICE + NOT_PRODUCTS_VARIANT + NOT_FOUND + REQUIRED + UNIQUE + PRODUCT_NOT_ASSIGNED_TO_CHANNEL +} + +type BulkProductError @doc(category: "Products") { + """ + 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!] +} + +""" +Update multiple product variants. + +Added in Saleor 3.11. + +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 ProductVariantBulkUpdate @doc(category: "Products") { + """Returns how many objects were updated.""" + count: Int! + + """List of the updated variants.""" + results: [ProductVariantBulkResult!]! + errors: [ProductVariantBulkError!]! +} + +""" +Input fields to update product variants. + +Added in Saleor 3.11. +""" +input ProductVariantBulkUpdateInput @doc(category: "Products") { + """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. + """ + preorder: PreorderSettingsInput + + """ + Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. + + Added in Saleor 3.1. + """ + 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!] + + """ + External ID of this product variant. + + Added in Saleor 3.10. + """ + externalReference: String + + """ + Stocks input. + + Added in Saleor 3.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + stocks: ProductVariantStocksUpdateInput + + """ + Channel listings input. + + Added in Saleor 3.12. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + channelListings: ProductVariantChannelListingUpdateInput + + """ID of the product variant to update.""" + id: ID! +} + +input ProductVariantStocksUpdateInput @doc(category: "Products") { + """List of warehouses to create stocks.""" + create: [StockInput!] + + """List of stocks to update.""" + update: [StockUpdateInput!] + + """List of stocks to remove.""" + remove: [ID!] +} + +input StockUpdateInput @doc(category: "Products") { + """Stock.""" + stock: ID! + + """Quantity of items available for sell.""" + quantity: Int! +} + +input ProductVariantChannelListingUpdateInput @doc(category: "Products") { + """List of channels to create variant channel listings.""" + create: [ProductVariantChannelListingAddInput!] + + """List of channel listings to update.""" + update: [ChannelListingUpdateInput!] + + """List of channel listings to remove.""" + remove: [ID!] +} + +input ChannelListingUpdateInput @doc(category: "Products") { + """ID of a channel listing.""" + channelListing: 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.""" + preorderThreshold: Int +} + +""" +Deletes product variants. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantBulkDelete @doc(category: "Products") { + """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!]! +} + +""" +Creates stocks for product variant. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantStocksCreate @doc(category: "Products") { + """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 BulkStockError @doc(category: "Products") { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: ProductErrorCode! + + """List of attributes IDs which causes the error.""" + attributes: [ID!] + + """List of attribute values IDs which causes the error.""" + values: [ID!] + + """Index of an input list item that caused the error.""" + index: Int +} + +""" +Delete stocks from product variant. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantStocksDelete @doc(category: "Products") { + """Updated product variant.""" + productVariant: ProductVariant + stockErrors: [StockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [StockError!]! +} + +type StockError @doc(category: "Products") { + """ + 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 @doc(category: "Products") { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +""" +Update stocks for product variant. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantStocksUpdate @doc(category: "Products") { + """Updated product variant.""" + productVariant: ProductVariant + bulkStockErrors: [BulkStockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [BulkStockError!]! +} + +""" +Updates an existing variant for product. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantUpdate @doc(category: "Products") { + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! + productVariant: ProductVariant +} + +input ProductVariantInput @doc(category: "Products") { + """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. + """ + preorder: PreorderSettingsInput + + """ + Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. + + Added in Saleor 3.1. + """ + 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!] + + """ + External ID of this product variant. + + Added in Saleor 3.10. + """ + externalReference: String +} + +""" +Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantSetDefault @doc(category: "Products") { + product: Product + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! +} + +""" +Creates/updates translations for a product variant. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type ProductVariantTranslate @doc(category: "Products") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + productVariant: ProductVariant +} + +input NameTranslationInput { + name: String +} + +""" +Manage product variant prices in channels. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantChannelListingUpdate @doc(category: "Products") { + """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!]! +} + +""" +Reorder product variant attribute values. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantReorderAttributeValues @doc(category: "Products") { + """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!]! +} + +""" +Deactivates product variant preorder. It changes all preorder allocation into regular allocation. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ProductVariantPreorderDeactivate @doc(category: "Products") { + """Product variant with ended preorder.""" + productVariant: ProductVariant + errors: [ProductError!]! +} + +""" +Assign an media to a product variant. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type VariantMediaAssign @doc(category: "Products") { + 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 @doc(category: "Products") { + productVariant: ProductVariant + media: ProductMedia + productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ProductError!]! +} + +""" +Captures the authorized payment amount. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type PaymentCapture @doc(category: "Payments") { + """Updated payment.""" + payment: Payment + paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PaymentError!]! +} + +type PaymentError @doc(category: "Payments") { + """ + 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 @doc(category: "Payments") { + 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 +} + +""" +Refunds the captured payment amount. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type PaymentRefund @doc(category: "Payments") { + """Updated payment.""" + payment: Payment + paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PaymentError!]! +} + +""" +Voids the authorized payment. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type PaymentVoid @doc(category: "Payments") { + """Updated payment.""" + payment: Payment + paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PaymentError!]! +} + +"""Initializes payment process when it is required by gateway.""" +type PaymentInitialize @doc(category: "Payments") { + 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 @doc(category: "Payments") { + """ID of a payment gateway.""" + gateway: String! + + """Payment gateway name.""" + name: String! + + """Initialized data by gateway.""" + data: JSONString +} + +"""Check payment balance.""" +type PaymentCheckBalance @doc(category: "Payments") { + """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 @doc(category: "Payments") { + """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! +} + +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 MoneyInput { + """Currency code.""" + currency: String! + + """Amount of money.""" + amount: PositiveDecimal! +} + +""" +Create transaction for checkout or order. + +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. +""" +type TransactionCreate @doc(category: "Payments") { + transaction: TransactionItem + errors: [TransactionCreateError!]! +} + +type TransactionCreateError @doc(category: "Payments") { + """ + 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 @doc(category: "Payments") { + INVALID + GRAPHQL_ERROR + NOT_FOUND + INCORRECT_CURRENCY + METADATA_KEY_REQUIRED + UNIQUE +} + +input TransactionCreateInput @doc(category: "Payments") { + """ + Status of the transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). The `status` is not needed. The amounts can be used to define the current status of transactions. + """ + status: String + + """ + Payment type used for this transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `name` and `message` instead. + """ + type: String + + """ + Payment name of the transaction. + + Added in Saleor 3.13. + """ + name: String + + """ + The message of the transaction. + + Added in Saleor 3.13. + """ + message: String + + """ + Reference of the transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `pspReference` instead. + """ + reference: String + + """ + PSP Reference of the transaction. + + Added in Saleor 3.13. + """ + pspReference: 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. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `amountCanceled` instead. + """ + amountVoided: MoneyInput + + """ + Amount canceled by this transaction. + + Added in Saleor 3.13. + """ + amountCanceled: MoneyInput + + """Payment public metadata.""" + metadata: [MetadataInput!] + + """Payment private metadata.""" + privateMetadata: [MetadataInput!] + + """ + The url that will allow to redirect user to payment provider page with transaction event details. + + Added in Saleor 3.13. + """ + externalUrl: String +} + +input TransactionEventInput @doc(category: "Payments") { + """ + Current status of the payment transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Status will be calculated by Saleor. + """ + status: TransactionStatus + + """ + Reference of the transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `pspReference` instead. + """ + reference: String + + """ + PSP Reference related to this action. + + Added in Saleor 3.13. + """ + pspReference: String + + """ + Name of the transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `message` instead. `name` field will be added to `message`. + """ + name: String + + """ + The message related to the event. + + Added in Saleor 3.13. + """ + message: String +} + +""" +Update transaction. + +Added in Saleor 3.4. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. + +Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. +""" +type TransactionUpdate @doc(category: "Payments") { + transaction: TransactionItem + errors: [TransactionUpdateError!]! +} + +type TransactionUpdateError @doc(category: "Payments") { + """ + 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 @doc(category: "Payments") { + INVALID + GRAPHQL_ERROR + NOT_FOUND + INCORRECT_CURRENCY + METADATA_KEY_REQUIRED + UNIQUE +} + +input TransactionUpdateInput @doc(category: "Payments") { + """ + Status of the transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). The `status` is not needed. The amounts can be used to define the current status of transactions. + """ + status: String + + """ + Payment type used for this transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `name` and `message` instead. + """ + type: String + + """ + Payment name of the transaction. + + Added in Saleor 3.13. + """ + name: String + + """ + The message of the transaction. + + Added in Saleor 3.13. + """ + message: String + + """ + Reference of the transaction. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `pspReference` instead. + """ + reference: String + + """ + PSP Reference of the transaction. + + Added in Saleor 3.13. + """ + pspReference: 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. + + DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use `amountCanceled` instead. + """ + amountVoided: MoneyInput + + """ + Amount canceled by this transaction. + + Added in Saleor 3.13. + """ + amountCanceled: MoneyInput + + """Payment public metadata.""" + metadata: [MetadataInput!] + + """Payment private metadata.""" + privateMetadata: [MetadataInput!] + + """ + The url that will allow to redirect user to payment provider page with transaction event details. + + Added in Saleor 3.13. + """ + externalUrl: String +} + +""" +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. +""" +type TransactionRequestAction @doc(category: "Payments") { + transaction: TransactionItem + errors: [TransactionRequestActionError!]! +} + +type TransactionRequestActionError @doc(category: "Payments") { + """ + 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 @doc(category: "Payments") { + INVALID + GRAPHQL_ERROR + NOT_FOUND + MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK +} + +""" +Report the event for the transaction. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. + +Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. +""" +type TransactionEventReport @doc(category: "Payments") { + """Defines if the reported event hasn't been processed earlier.""" + alreadyProcessed: Boolean + + """The transaction related to the reported event.""" + transaction: TransactionItem + + """ + The event assigned to this report. if `alreadyProcessed` is set to `true`, the previously processed event will be returned. + """ + transactionEvent: TransactionEvent + errors: [TransactionEventReportError!]! +} + +type TransactionEventReportError @doc(category: "Payments") { + """ + 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: TransactionEventReportErrorCode! +} + +"""An enumeration.""" +enum TransactionEventReportErrorCode @doc(category: "Payments") { + INVALID + GRAPHQL_ERROR + NOT_FOUND + INCORRECT_DETAILS + ALREADY_EXISTS +} + +""" +Initializes a payment gateway session. It triggers the webhook `PAYMENT_GATEWAY_INITIALIZE_SESSION`, to the requested `paymentGateways`. If `paymentGateways` is not provided, the webhook will be send to all subscribed payment gateways. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type PaymentGatewayInitialize @doc(category: "Payments") { + gatewayConfigs: [PaymentGatewayConfig!] + errors: [PaymentGatewayInitializeError!]! +} + +type PaymentGatewayConfig @doc(category: "Payments") { + """The app identifier.""" + id: String! + + """The JSON data required to initialize the payment gateway.""" + data: JSON + errors: [PaymentGatewayConfigError!] +} + +scalar JSON + +type PaymentGatewayConfigError @doc(category: "Payments") { + """ + 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: PaymentGatewayConfigErrorCode! +} + +"""An enumeration.""" +enum PaymentGatewayConfigErrorCode @doc(category: "Payments") { + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +type PaymentGatewayInitializeError @doc(category: "Payments") { + """ + 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: PaymentGatewayInitializeErrorCode! +} + +"""An enumeration.""" +enum PaymentGatewayInitializeErrorCode @doc(category: "Payments") { + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +input PaymentGatewayToInitialize @doc(category: "Payments") { + """The identifier of the payment gateway app to initialize.""" + id: String! + + """The data that will be passed to the payment gateway.""" + data: JSON +} + +""" +Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type TransactionInitialize @doc(category: "Payments") { + """The initialized transaction.""" + transaction: TransactionItem + + """The event created for the initialized transaction.""" + transactionEvent: TransactionEvent + + """The JSON data required to finalize the payment.""" + data: JSON + errors: [TransactionInitializeError!]! +} + +type TransactionInitializeError @doc(category: "Payments") { + """ + 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: TransactionInitializeErrorCode! +} + +"""An enumeration.""" +enum TransactionInitializeErrorCode @doc(category: "Payments") { + GRAPHQL_ERROR + INVALID + NOT_FOUND +} + +""" +Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type TransactionProcess @doc(category: "Payments") { + """The processed transaction.""" + transaction: TransactionItem + + """The event created for the processed transaction.""" + transactionEvent: TransactionEvent + + """The json data required to finalize the payment.""" + data: JSON + errors: [TransactionProcessError!]! +} + +type TransactionProcessError @doc(category: "Payments") { + """ + 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: TransactionProcessErrorCode! +} + +"""An enumeration.""" +enum TransactionProcessErrorCode @doc(category: "Payments") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + TRANSACTION_ALREADY_PROCESSED + MISSING_PAYMENT_APP_RELATION + MISSING_PAYMENT_APP +} + +""" +Creates a new page. + +Requires one of the following permissions: MANAGE_PAGES. +""" +type PageCreate @doc(category: "Pages") { + pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PageError!]! + page: Page +} + +type PageError @doc(category: "Pages") { + """ + 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 @doc(category: "Pages") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + DUPLICATED_INPUT_ITEM + ATTRIBUTE_ALREADY_ASSIGNED +} + +input PageCreateInput @doc(category: "Pages") { + """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! +} + +""" +Deletes a page. + +Requires one of the following permissions: MANAGE_PAGES. +""" +type PageDelete @doc(category: "Pages") { + pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PageError!]! + page: Page +} + +""" +Deletes pages. + +Requires one of the following permissions: MANAGE_PAGES. +""" +type PageBulkDelete @doc(category: "Pages") { + """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 @doc(category: "Pages") { + """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!]! +} + +""" +Updates an existing page. + +Requires one of the following permissions: MANAGE_PAGES. +""" +type PageUpdate @doc(category: "Pages") { + pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PageError!]! + page: Page +} + +input PageInput @doc(category: "Pages") { + """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 +} + +""" +Creates/updates translations for a page. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type PageTranslate @doc(category: "Pages") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + page: PageTranslatableContent +} + +input PageTranslationInput { + seoTitle: String + seoDescription: String + title: String + + """ + Translated page content. + + Rich text format. For reference see https://editorjs.io/ + """ + content: JSONString +} + +""" +Create a new page type. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type PageTypeCreate @doc(category: "Pages") { + pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PageError!]! + pageType: PageType +} + +input PageTypeCreateInput @doc(category: "Pages") { + """Name of the page type.""" + name: String + + """Page type slug.""" + slug: String + + """List of attribute IDs to be assigned to the page type.""" + addAttributes: [ID!] +} + +""" +Update page type. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type PageTypeUpdate @doc(category: "Pages") { + pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PageError!]! + pageType: PageType +} + +input PageTypeUpdateInput @doc(category: "Pages") { + """Name of the page type.""" + name: String + + """Page type slug.""" + slug: String + + """List of attribute IDs to be assigned to the page type.""" + addAttributes: [ID!] + + """List of attribute IDs to be assigned to the page type.""" + removeAttributes: [ID!] +} + +""" +Delete a page type. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type PageTypeDelete @doc(category: "Pages") { + pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PageError!]! + pageType: PageType +} + +""" +Delete page types. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type PageTypeBulkDelete @doc(category: "Pages") { + """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!]! +} + +""" +Assign attributes to a given page type. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type PageAttributeAssign @doc(category: "Pages") { + """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 @doc(category: "Pages") { + """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!]! +} + +""" +Reorder the attributes of a page type. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type PageTypeReorderAttributes @doc(category: "Pages") { + """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!]! +} + +""" +Reorder page attribute values. + +Requires one of the following permissions: MANAGE_PAGES. +""" +type PageReorderAttributeValues @doc(category: "Pages") { + """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!]! +} + +""" +Completes creating an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type DraftOrderComplete @doc(category: "Orders") { + """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 @doc(category: "Orders") { + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! + order: Order +} + +input DraftOrderCreateInput @doc(category: "Orders") { + """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 + + """ + External ID of this order. + + Added in Saleor 3.10. + """ + externalReference: String + + """Variant line input consisting of variant ID and quantity of products.""" + lines: [OrderLineCreateInput!] +} + +input OrderLineCreateInput @doc(category: "Orders") { + """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. + """ + forceNewLine: Boolean = false + + """ + Custom price of the item.When the line with the same variant will be provided multiple times, the last price will be used. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + price: PositiveDecimal +} + +""" +Deletes a draft order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type DraftOrderDelete @doc(category: "Orders") { + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! + order: Order +} + +""" +Deletes draft orders. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type DraftOrderBulkDelete @doc(category: "Orders") { + """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!]! +} + +""" +Deletes order lines. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type DraftOrderLinesBulkDelete @doc(category: "Orders") { + """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 @doc(category: "Orders") { + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! + order: Order +} + +input DraftOrderInput @doc(category: "Orders") { + """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 + + """ + External ID of this order. + + Added in Saleor 3.10. + """ + externalReference: String +} + +""" +Adds note to the order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderAddNote @doc(category: "Orders") { + """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 @doc(category: "Orders") { + """Note message.""" + message: String! +} + +""" +Cancel an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderCancel @doc(category: "Orders") { + """Canceled order.""" + order: Order + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! +} + +""" +Capture an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderCapture @doc(category: "Orders") { + """Captured order.""" + order: Order + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! +} + +""" +Confirms an unconfirmed order by changing status to unfulfilled. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderConfirm @doc(category: "Orders") { + order: Order + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! +} + +""" +Creates new fulfillments for an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderFulfill @doc(category: "Orders") { + """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 @doc(category: "Orders") { + """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 @doc(category: "Orders") { + """The ID of the order line.""" + orderLineId: ID + + """List of stock items to create.""" + stocks: [OrderFulfillStockInput!]! +} + +input OrderFulfillStockInput @doc(category: "Orders") { + """The number of line items to be fulfilled from given warehouse.""" + quantity: Int! + + """ID of the warehouse from which the item will be fulfilled.""" + warehouse: ID! +} + +""" +Cancels existing fulfillment and optionally restocks items. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type FulfillmentCancel @doc(category: "Orders") { + """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 @doc(category: "Orders") { + """ + ID of a warehouse where items will be restocked. Optional when fulfillment is in WAITING_FOR_APPROVAL state. + """ + warehouseId: ID +} + +""" +Approve existing fulfillment. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type FulfillmentApprove @doc(category: "Orders") { + """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!]! +} + +""" +Updates a fulfillment for an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type FulfillmentUpdateTracking @doc(category: "Orders") { + """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 @doc(category: "Orders") { + """Fulfillment tracking number.""" + trackingNumber: String + + """If true, send an email notification to the customer.""" + notifyCustomer: Boolean = false +} + +""" +Refund products. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type FulfillmentRefundProducts @doc(category: "Orders") { + """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!]! +} + +input OrderRefundProductsInput @doc(category: "Orders") { + """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 OrderRefundLineInput @doc(category: "Orders") { + """The ID of the order line to refund.""" + orderLineId: ID! + + """The number of items to be refunded.""" + quantity: Int! +} + +input OrderRefundFulfillmentLineInput @doc(category: "Orders") { + """The ID of the fulfillment line to refund.""" + fulfillmentLineId: ID! + + """The number of items to be refunded.""" + quantity: Int! +} + +""" +Return products. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type FulfillmentReturnProducts @doc(category: "Orders") { + """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!]! +} + +input OrderReturnProductsInput @doc(category: "Orders") { + """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 +} + +input OrderReturnLineInput @doc(category: "Orders") { + """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 OrderReturnFulfillmentLineInput @doc(category: "Orders") { + """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 +} + +""" +Adds granted refund to the order. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderGrantRefundCreate @doc(category: "Orders") { + """Order which has assigned new grant refund.""" + order: Order + + """Created granted refund.""" + grantedRefund: OrderGrantedRefund + errors: [OrderGrantRefundCreateError!]! +} + +type OrderGrantRefundCreateError @doc(category: "Orders") { + """ + 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: OrderGrantRefundCreateErrorCode! +} + +"""An enumeration.""" +enum OrderGrantRefundCreateErrorCode @doc(category: "Orders") { + GRAPHQL_ERROR + NOT_FOUND +} + +input OrderGrantRefundCreateInput @doc(category: "Orders") { + """Amount of the granted refund.""" + amount: Decimal! + + """Reason of the granted refund.""" + reason: String +} + +""" +Updates granted refund. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderGrantRefundUpdate @doc(category: "Orders") { + """Order which has assigned updated grant refund.""" + order: Order + + """Created granted refund.""" + grantedRefund: OrderGrantedRefund + errors: [OrderGrantRefundUpdateError!]! + orderGrantedRefund: OrderGrantedRefund +} + +type OrderGrantRefundUpdateError @doc(category: "Orders") { + """ + 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: OrderGrantRefundUpdateErrorCode! +} + +"""An enumeration.""" +enum OrderGrantRefundUpdateErrorCode @doc(category: "Orders") { + GRAPHQL_ERROR + NOT_FOUND + REQUIRED +} + +input OrderGrantRefundUpdateInput @doc(category: "Orders") { + """Amount of the granted refund.""" + amount: Decimal + + """Reason of the granted refund.""" + reason: String +} + +""" +Create order lines for an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderLinesCreate @doc(category: "Orders") { + """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!]! +} + +""" +Deletes an order line from an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderLineDelete @doc(category: "Orders") { + """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!]! +} + +""" +Updates an order line of an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderLineUpdate @doc(category: "Orders") { + """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 +} + +input OrderLineInput @doc(category: "Orders") { + """Number of variant items ordered.""" + quantity: Int! +} + +""" +Adds discount to the order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderDiscountAdd @doc(category: "Orders") { + """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 @doc(category: "Orders") { + """Type of the discount: fixed or percent""" + valueType: DiscountValueTypeEnum! + + """Value of the discount. Can store fixed value or percent value""" + value: PositiveDecimal! + + """Explanation for the applied discount.""" + reason: String +} + +""" +Update discount for the order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderDiscountUpdate @doc(category: "Orders") { + """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!]! +} + +""" +Remove discount from the order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderDiscountDelete @doc(category: "Orders") { + """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!]! +} + +""" +Update discount for the order line. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderLineDiscountUpdate @doc(category: "Orders") { + """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!]! +} + +""" +Remove discount applied to the order line. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderLineDiscountRemove @doc(category: "Orders") { + """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!]! +} + +""" +Mark order as manually paid. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderMarkAsPaid @doc(category: "Orders") { + """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!]! +} + +""" +Refund an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderRefund @doc(category: "Orders") { + """A refunded order.""" + order: Order + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! +} + +""" +Updates an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderUpdate @doc(category: "Orders") { + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! + order: Order +} + +input OrderUpdateInput @doc(category: "Orders") { + """Billing address of the customer.""" + billingAddress: AddressInput + + """Email address of the customer.""" + userEmail: String + + """Shipping address of the customer.""" + shippingAddress: AddressInput + + """ + External ID of this order. + + Added in Saleor 3.10. + """ + externalReference: String +} + +""" +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 @doc(category: "Orders") { + """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 @doc(category: "Orders") { + """ + ID of the selected shipping method, pass null to remove currently assigned shipping method. + """ + shippingMethod: ID +} + +""" +Void an order. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderVoid @doc(category: "Orders") { + """A voided order.""" + order: Order + orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [OrderError!]! +} + +""" +Cancels orders. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type OrderBulkCancel @doc(category: "Orders") { + """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!]! +} + +""" +Creates multiple orders. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. + +Requires one of the following permissions: MANAGE_ORDERS_IMPORT. +""" +type OrderBulkCreate @doc(category: "Orders") { + """Returns how many objects were created.""" + count: Int! + + """List of the created orders.""" + results: [OrderBulkCreateResult!]! + errors: [OrderBulkCreateError!]! +} + +type OrderBulkCreateResult @doc(category: "Orders") { + """Order data.""" + order: Order + + """List of errors occurred on create attempt.""" + errors: [OrderBulkCreateError!] +} + +type OrderBulkCreateError @doc(category: "Orders") { + """ + Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + path: String + + """The error message.""" + message: String + + """The error code.""" + code: OrderBulkCreateErrorCode +} + +"""An enumeration.""" +enum OrderBulkCreateErrorCode { + GRAPHQL_ERROR + REQUIRED + INVALID + NOT_FOUND + UNIQUE + BULK_LIMIT + TOO_MANY_IDENTIFIERS + FUTURE_DATE + INVALID_QUANTITY + PRICE_ERROR + NOTE_LENGTH + INSUFFICIENT_STOCK + NON_EXISTING_STOCK + NO_RELATED_ORDER_LINE + NEGATIVE_INDEX + ORDER_LINE_FULFILLMENT_LINE_MISMATCH + METADATA_KEY_REQUIRED + INCORRECT_CURRENCY +} + +input OrderBulkCreateInput @doc(category: "Orders") { + """External ID of the order.""" + externalReference: String + + """Slug of the channel associated with the order.""" + channel: String! + + """The date, when the order was inserted to Saleor database.""" + createdAt: DateTime! + + """Status of the order.""" + status: OrderStatus + + """Customer associated with the order.""" + user: OrderBulkCreateUserInput! + + """Tracking ID of the customer.""" + trackingClientId: String + + """Billing address of the customer.""" + billingAddress: AddressInput! + + """Shipping address of the customer.""" + shippingAddress: AddressInput + + """Currency code.""" + currency: String! + + """Metadata of the order.""" + metadata: [MetadataInput!] + + """Private metadata of the order.""" + privateMetadata: [MetadataInput!] + + """Note about customer.""" + customerNote: String + + """Notes related to the order.""" + notes: [OrderBulkCreateNoteInput!] + + """Order language code.""" + languageCode: LanguageCodeEnum! + + """ + Determines whether checkout prices should include taxes, when displayed in a storefront. + """ + displayGrossPrices: Boolean + + """Weight of the order in kg.""" + weight: WeightScalar + + """ + URL of a view, where users should be redirected to see the order details. + """ + redirectUrl: String + + """List of order lines.""" + lines: [OrderBulkCreateOrderLineInput!]! + + """The delivery method selected for this order.""" + deliveryMethod: OrderBulkCreateDeliveryMethodInput + + """List of gift card codes associated with the order.""" + giftCards: [String!] + + """Code of a voucher associated with the order.""" + voucher: String + + """List of discounts.""" + discounts: [OrderDiscountCommonInput!] + + """Fulfillments of the order.""" + fulfillments: [OrderBulkCreateFulfillmentInput!] + + """Transactions related to the order.""" + transactions: [TransactionCreateInput!] + + """Invoices related to the order.""" + invoices: [OrderBulkCreateInvoiceInput!] +} + +input OrderBulkCreateUserInput @doc(category: "Orders") { + """Customer ID associated with the order.""" + id: ID + + """Customer email associated with the order.""" + email: String + + """Customer external ID associated with the order.""" + externalReference: String +} + +input OrderBulkCreateNoteInput @doc(category: "Orders") { + """Note message. Max characters: 255.""" + message: String! + + """The date associated with the message.""" + date: DateTime + + """The user ID associated with the message.""" + userId: ID + + """The user email associated with the message.""" + userEmail: ID + + """The user external ID associated with the message.""" + userExternalReference: ID + + """The app ID associated with the message.""" + appId: ID +} + +input OrderBulkCreateOrderLineInput @doc(category: "Orders") { + """The ID of the product variant.""" + variantId: ID + + """The SKU of the product variant.""" + variantSku: String + + """The external ID of the product variant.""" + variantExternalReference: String + + """The name of the product variant.""" + variantName: String + + """The name of the product.""" + productName: String + + """Translation of the product variant name.""" + translatedVariantName: String + + """Translation of the product name.""" + translatedProductName: String + + """The date, when the order line was created.""" + createdAt: DateTime! + + """Determines whether shipping of the order line items is required.""" + isShippingRequired: Boolean! + + """Gift card flag.""" + isGiftCard: Boolean! + + """Number of items in the order line""" + quantity: Int! + + """Price of the order line.""" + totalPrice: TaxedMoneyInput! + + """Price of the order line excluding applied discount.""" + undiscountedTotalPrice: TaxedMoneyInput! + + """The ID of the warehouse, where the line will be allocated.""" + warehouse: ID! + + """Metadata of the order line.""" + metadata: [MetadataInput!] + + """Private metadata of the order line.""" + privateMetadata: [MetadataInput!] + + """Tax rate of the order line.""" + taxRate: PositiveDecimal + + """The ID of the tax class.""" + taxClassId: ID + + """The name of the tax class.""" + taxClassName: String + + """Metadata of the tax class.""" + taxClassMetadata: [MetadataInput!] + + """Private metadata of the tax class.""" + taxClassPrivateMetadata: [MetadataInput!] +} + +input TaxedMoneyInput @doc(category: "Orders") { + """Gross value of an item.""" + gross: PositiveDecimal! + + """Net value of an item.""" + net: PositiveDecimal! +} + +input OrderBulkCreateDeliveryMethodInput @doc(category: "Orders") { + """The ID of the warehouse.""" + warehouseId: ID + + """The name of the warehouse.""" + warehouseName: String + + """The ID of the shipping method.""" + shippingMethodId: ID + + """The name of the shipping method.""" + shippingMethodName: String + + """The price of the shipping.""" + shippingPrice: TaxedMoneyInput + + """Tax rate of the shipping.""" + shippingTaxRate: PositiveDecimal + + """The ID of the tax class.""" + shippingTaxClassId: ID + + """The name of the tax class.""" + shippingTaxClassName: String + + """Metadata of the tax class.""" + shippingTaxClassMetadata: [MetadataInput!] + + """Private metadata of the tax class.""" + shippingTaxClassPrivateMetadata: [MetadataInput!] +} + +input OrderBulkCreateFulfillmentInput @doc(category: "Orders") { + """Fulfillment's tracking code.""" + trackingCode: String + + """List of items informing how to fulfill the order.""" + lines: [OrderBulkCreateFulfillmentLineInput!] +} + +input OrderBulkCreateFulfillmentLineInput @doc(category: "Orders") { + """The ID of the product variant.""" + variantId: ID + + """The SKU of the product variant.""" + variantSku: String + + """The external ID of the product variant.""" + variantExternalReference: String + + """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! + + """0-based index of order line, which the fulfillment line refers to.""" + orderLineIndex: Int! +} + +input OrderBulkCreateInvoiceInput @doc(category: "Orders") { + """The date, when the invoice was created.""" + createdAt: DateTime! + + """Invoice number.""" + number: String + + """URL of the invoice to download.""" + url: String + + """Metadata of the invoice.""" + metadata: [MetadataInput!] + + """Private metadata of the invoice.""" + privateMetadata: [MetadataInput!] +} + +""" +Determine how stocks should be updated, while processing an order. + + SKIP - stocks are not checked and not updated. + UPDATE - only do update, if there is enough stock. + FORCE - force update, if there is not enough stock. +""" +enum StockUpdatePolicyEnum { + SKIP + UPDATE + FORCE +} + +""" +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 +} + +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 +} + +""" +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 +} + +""" +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 +} + +""" +Assigns storefront's navigation menus. + +Requires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS. +""" +type AssignNavigation @doc(category: "Menu") { + """Assigned navigation menu.""" + menu: Menu + menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [MenuError!]! +} + +type MenuError @doc(category: "Menu") { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: MenuErrorCode! +} + +"""An enumeration.""" +enum MenuErrorCode { + CANNOT_ASSIGN_NODE + GRAPHQL_ERROR + INVALID + INVALID_MENU_ITEM + NO_MENU_ITEM_PROVIDED + NOT_FOUND + REQUIRED + TOO_MANY_MENU_ITEMS + UNIQUE +} + +enum NavigationType { + """Main storefront navigation.""" + MAIN + + """Secondary storefront navigation.""" + SECONDARY +} + +""" +Creates a new Menu. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuCreate @doc(category: "Menu") { + 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!] +} + +input MenuItemInput { + """Name of the menu item.""" + name: String + + """URL of the pointed item.""" + url: String + + """Category to which item points.""" + category: ID + + """Collection to which item points.""" + collection: ID + + """Page to which item points.""" + page: ID +} + +""" +Deletes a menu. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuDelete @doc(category: "Menu") { + menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [MenuError!]! + menu: Menu +} + +""" +Deletes menus. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuBulkDelete @doc(category: "Menu") { + """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!]! +} + +""" +Updates a menu. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuUpdate @doc(category: "Menu") { + menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [MenuError!]! + menu: Menu +} + +input MenuInput { + """Name of the menu.""" + name: String + + """Slug of the menu.""" + slug: String +} + +""" +Creates a new menu item. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuItemCreate @doc(category: "Menu") { + 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 +} + +""" +Deletes a menu item. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuItemDelete @doc(category: "Menu") { + menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [MenuError!]! + menuItem: MenuItem +} + +""" +Deletes menu items. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuItemBulkDelete @doc(category: "Menu") { + """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!]! +} + +""" +Updates a menu item. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuItemUpdate @doc(category: "Menu") { + menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [MenuError!]! + menuItem: MenuItem +} + +""" +Creates/updates translations for a menu item. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type MenuItemTranslate @doc(category: "Menu") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + menuItem: MenuItem +} + +""" +Moves items of menus. + +Requires one of the following permissions: MANAGE_MENUS. +""" +type MenuItemMove @doc(category: "Menu") { + """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 +} + +""" +Request an invoice for the order using plugin. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type InvoiceRequest @doc(category: "Orders") { + """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 +} + +type InvoiceError @doc(category: "Orders") { + """ + 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 @doc(category: "Orders") { + REQUIRED + NOT_READY + URL_NOT_SET + EMAIL_NOT_SET + NUMBER_NOT_SET + NOT_FOUND + INVALID_STATUS + NO_INVOICE_PLUGIN +} + +""" +Requests deletion of an invoice. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type InvoiceRequestDelete @doc(category: "Orders") { + invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [InvoiceError!]! + invoice: Invoice +} + +""" +Creates a ready to send invoice. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type InvoiceCreate @doc(category: "Orders") { + invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [InvoiceError!]! + invoice: Invoice +} + +input InvoiceCreateInput @doc(category: "Orders") { + """Invoice number.""" + number: String! + + """URL of an invoice to download.""" + url: String! + + """ + Fields required to update the invoice metadata. + + Added in Saleor 3.14. + """ + metadata: [MetadataInput!] + + """ + Fields required to update the invoice private metadata. + + Added in Saleor 3.14. + """ + privateMetadata: [MetadataInput!] +} + +""" +Deletes an invoice. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type InvoiceDelete @doc(category: "Orders") { + invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [InvoiceError!]! + invoice: Invoice +} + +""" +Updates an invoice. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type InvoiceUpdate @doc(category: "Orders") { + invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [InvoiceError!]! + invoice: Invoice +} + +input UpdateInvoiceInput @doc(category: "Orders") { + """Invoice number""" + number: String + + """URL of an invoice to download.""" + url: String + + """ + Fields required to update the invoice metadata. + + Added in Saleor 3.14. + """ + metadata: [MetadataInput!] + + """ + Fields required to update the invoice private metadata. + + Added in Saleor 3.14. + """ + privateMetadata: [MetadataInput!] +} + +""" +Send an invoice notification to the customer. + +Requires one of the following permissions: MANAGE_ORDERS. +""" +type InvoiceSendNotification @doc(category: "Orders") { + invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [InvoiceError!]! + invoice: Invoice +} + +""" +Activate a gift card. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardActivate @doc(category: "Gift cards") { + """Activated gift card.""" + giftCard: GiftCard + giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [GiftCardError!]! +} + +type GiftCardError @doc(category: "Gift cards") { + """ + 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 @doc(category: "Gift cards") { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + EXPIRED_GIFT_CARD + DUPLICATED_INPUT_ITEM +} + +""" +Creates a new gift card. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardCreate @doc(category: "Gift cards") { + giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [GiftCardError!]! + giftCard: GiftCard +} + +input GiftCardCreateInput @doc(category: "Gift cards") { + """ + The gift card tags to add. + + Added in Saleor 3.1. + """ + addTags: [String!] + + """ + The gift card expiry date. + + Added in Saleor 3.1. + """ + 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. + """ + channel: String + + """ + Determine if gift card is active. + + Added in Saleor 3.1. + """ + 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: String +} + +input PriceInput { + """Currency code.""" + currency: String! + + """Amount of money.""" + amount: PositiveDecimal! +} + +""" +Delete gift card. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardDelete @doc(category: "Gift cards") { + giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [GiftCardError!]! + giftCard: GiftCard +} + +""" +Deactivate a gift card. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardDeactivate @doc(category: "Gift cards") { + """Deactivated gift card.""" + giftCard: GiftCard + giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [GiftCardError!]! +} + +""" +Update a gift card. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardUpdate @doc(category: "Gift cards") { + giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [GiftCardError!]! + giftCard: GiftCard +} + +input GiftCardUpdateInput @doc(category: "Gift cards") { + """ + The gift card tags to add. + + Added in Saleor 3.1. + """ + addTags: [String!] + + """ + The gift card expiry date. + + Added in Saleor 3.1. + """ + 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. + """ + removeTags: [String!] + + """ + The gift card balance amount. + + Added in Saleor 3.1. + """ + balanceAmount: PositiveDecimal +} + +""" +Resend a gift card. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardResend @doc(category: "Gift cards") { + """Gift card which has been sent.""" + giftCard: GiftCard + errors: [GiftCardError!]! +} + +input GiftCardResendInput @doc(category: "Gift cards") { + """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! +} + +""" +Adds note to the gift card. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardAddNote @doc(category: "Gift cards") { + """Gift card with the note added.""" + giftCard: GiftCard + + """Gift card note created.""" + event: GiftCardEvent + errors: [GiftCardError!]! +} + +input GiftCardAddNoteInput @doc(category: "Gift cards") { + """Note message.""" + message: String! +} + +""" +Create gift cards. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardBulkCreate @doc(category: "Gift cards") { + """Returns how many objects were created.""" + count: Int! + + """List of created gift cards.""" + giftCards: [GiftCard!]! + errors: [GiftCardError!]! +} + +input GiftCardBulkCreateInput @doc(category: "Gift cards") { + """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! +} + +""" +Delete gift cards. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardBulkDelete @doc(category: "Gift cards") { + """Returns how many objects were affected.""" + count: Int! + errors: [GiftCardError!]! +} + +""" +Activate gift cards. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardBulkActivate @doc(category: "Gift cards") { + """Returns how many objects were affected.""" + count: Int! + errors: [GiftCardError!]! +} + +""" +Deactivate gift cards. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type GiftCardBulkDeactivate @doc(category: "Gift cards") { + """Returns how many objects were affected.""" + count: Int! + errors: [GiftCardError!]! +} + +""" +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!]! +} + +type PluginError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: PluginErrorCode! +} + +"""An enumeration.""" +enum PluginErrorCode { + GRAPHQL_ERROR + INVALID + PLUGIN_MISCONFIGURED + NOT_FOUND + REQUIRED + UNIQUE +} + +input PluginUpdateInput { + """Indicates whether the plugin should be enabled.""" + active: Boolean + + """Configuration of the plugin.""" + configuration: [ConfigurationItemInput!] +} + +input ConfigurationItemInput { + """Name of the field to update.""" + name: String! + + """Value of the given field to update.""" + value: String +} + +""" +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!]! +} + +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 +} + +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! +} + +""" +Creates a new sale. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type SaleCreate @doc(category: "Discounts") { + discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [DiscountError!]! + sale: Sale +} + +type DiscountError @doc(category: "Discounts") { + """ + 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 @doc(category: "Discounts") { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT + DUPLICATED_INPUT_ITEM +} + +input SaleInput @doc(category: "Discounts") { + """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 +} + +""" +Deletes a sale. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type SaleDelete @doc(category: "Discounts") { + discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [DiscountError!]! + sale: Sale +} + +""" +Deletes sales. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type SaleBulkDelete @doc(category: "Discounts") { + """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!]! +} + +""" +Updates a sale. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type SaleUpdate @doc(category: "Discounts") { + discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [DiscountError!]! + sale: Sale +} + +""" +Adds products, categories, collections to a voucher. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type SaleAddCatalogues @doc(category: "Discounts") { + """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!]! +} + +input CatalogueInput @doc(category: "Discounts") { + """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!] +} + +""" +Removes products, categories, collections from a sale. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type SaleRemoveCatalogues @doc(category: "Discounts") { + """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!]! +} + +""" +Creates/updates translations for a sale. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type SaleTranslate @doc(category: "Discounts") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + sale: Sale +} + +""" +Manage sale's availability in channels. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type SaleChannelListingUpdate @doc(category: "Discounts") { + """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!]! +} + +input SaleChannelListingInput @doc(category: "Discounts") { + """List of channels to which the sale should be assigned.""" + addChannels: [SaleChannelListingAddInput!] + + """List of channels from which the sale should be unassigned.""" + removeChannels: [ID!] +} + +input SaleChannelListingAddInput @doc(category: "Discounts") { + """ID of a channel.""" + channelId: ID! + + """The value of the discount.""" + discountValue: PositiveDecimal! +} + +""" +Creates a new voucher. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type VoucherCreate @doc(category: "Discounts") { + discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [DiscountError!]! + voucher: Voucher +} + +input VoucherInput @doc(category: "Discounts") { + """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 +} + +""" +Deletes a voucher. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type VoucherDelete @doc(category: "Discounts") { + discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [DiscountError!]! + voucher: Voucher +} + +""" +Deletes vouchers. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type VoucherBulkDelete @doc(category: "Discounts") { + """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!]! +} + +""" +Updates a voucher. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type VoucherUpdate @doc(category: "Discounts") { + discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [DiscountError!]! + voucher: Voucher +} + +""" +Adds products, categories, collections to a voucher. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type VoucherAddCatalogues @doc(category: "Discounts") { + """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!]! +} + +""" +Removes products, categories, collections from a voucher. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type VoucherRemoveCatalogues @doc(category: "Discounts") { + """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!]! +} + +""" +Creates/updates translations for a voucher. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type VoucherTranslate @doc(category: "Discounts") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + voucher: Voucher +} + +""" +Manage voucher's availability in channels. + +Requires one of the following permissions: MANAGE_DISCOUNTS. +""" +type VoucherChannelListingUpdate @doc(category: "Discounts") { + """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!]! +} + +input VoucherChannelListingInput @doc(category: "Discounts") { + """List of channels to which the voucher should be assigned.""" + addChannels: [VoucherChannelListingAddInput!] + + """List of channels from which the voucher should be unassigned.""" + removeChannels: [ID!] +} + +input VoucherChannelListingAddInput @doc(category: "Discounts") { + """ID of a channel.""" + channelId: ID! + + """Value of the voucher.""" + discountValue: PositiveDecimal + + """Min purchase amount required to apply the voucher.""" + minAmountSpent: PositiveDecimal +} + +""" +Export products to csv file. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type ExportProducts @doc(category: "Products") { + """ + 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!]! +} + +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 +} + +input ExportProductsInput @doc(category: "Products") { + """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 @doc(category: "Products") { + """Export all products.""" + ALL + + """Export products with given ids.""" + IDS + + """Export the filtered products.""" + FILTER +} + +input ExportInfoInput @doc(category: "Products") { + """List of attribute ids witch should be exported.""" + attributes: [ID!] + + """List of warehouse ids witch should be exported.""" + warehouses: [ID!] + + """List of channels ids which should be exported.""" + channels: [ID!] + + """List of product fields witch should be exported.""" + fields: [ProductFieldEnum!] +} + +enum ProductFieldEnum @doc(category: "Products") { + NAME + DESCRIPTION + PRODUCT_TYPE + CATEGORY + PRODUCT_WEIGHT + COLLECTIONS + CHARGE_TAXES + PRODUCT_MEDIA + VARIANT_ID + VARIANT_SKU + VARIANT_WEIGHT + VARIANT_MEDIA +} + +"""An enumeration.""" +enum FileTypesEnum { + CSV + XLSX +} + +""" +Export gift cards to csv file. + +Added in Saleor 3.1. + +Requires one of the following permissions: MANAGE_GIFT_CARD. +""" +type ExportGiftCards @doc(category: "Gift cards") { + """ + The newly created export file job which is responsible for export data. + """ + exportFile: ExportFile + errors: [ExportError!]! +} + +input ExportGiftCardsInput @doc(category: "Gift cards") { + """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! +} + +""" +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!]! +} + +type UploadError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """The error code.""" + code: UploadErrorCode! +} + +"""An enumeration.""" +enum UploadErrorCode { + GRAPHQL_ERROR +} + +"""Adds a gift card or a voucher to a checkout.""" +type CheckoutAddPromoCode @doc(category: "Checkout") { + """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!]! +} + +type CheckoutError @doc(category: "Checkout") { + """ + 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 @doc(category: "Checkout") { + 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 +} + +"""Update billing address in the existing checkout.""" +type CheckoutBillingAddressUpdate @doc(category: "Checkout") { + """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 CheckoutAddressValidationRules @doc(category: "Checkout") { + """ + 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 +} + +""" +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 @doc(category: "Checkout") { + """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!]! +} + +"""Create a new checkout.""" +type CheckoutCreate @doc(category: "Checkout") { + """ + 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 @doc(category: "Checkout") { + """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. + """ + validationRules: CheckoutValidationRules +} + +input CheckoutLineInput @doc(category: "Checkout") { + """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. + """ + price: PositiveDecimal + + """ + Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. + + Added in Saleor 3.6. + """ + forceNewLine: Boolean = false + + """ + Fields required to update the object's metadata. + + Added in Saleor 3.8. + """ + metadata: [MetadataInput!] +} + +input CheckoutValidationRules @doc(category: "Checkout") { + """ + 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 +} + +""" +Create new checkout from existing order. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type CheckoutCreateFromOrder @doc(category: "Checkout") { + """Variants that were not attached to the checkout.""" + unavailableVariants: [CheckoutCreateFromOrderUnavailableVariant!] + + """Created checkout.""" + checkout: Checkout + errors: [CheckoutCreateFromOrderError!]! +} + +type CheckoutCreateFromOrderUnavailableVariant @doc(category: "Checkout") { + """The error message.""" + message: String! + + """The error code.""" + code: CheckoutCreateFromOrderUnavailableVariantErrorCode! + + """Variant ID that is unavailable.""" + variantId: ID! + + """Order line ID that is unavailable.""" + lineId: ID! +} + +"""An enumeration.""" +enum CheckoutCreateFromOrderUnavailableVariantErrorCode @doc(category: "Checkout") { + NOT_FOUND + PRODUCT_UNAVAILABLE_FOR_PURCHASE + UNAVAILABLE_VARIANT_IN_CHANNEL + PRODUCT_NOT_PUBLISHED + QUANTITY_GREATER_THAN_LIMIT + INSUFFICIENT_STOCK +} + +type CheckoutCreateFromOrderError @doc(category: "Checkout") { + """ + 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: CheckoutCreateFromOrderErrorCode! +} + +"""An enumeration.""" +enum CheckoutCreateFromOrderErrorCode @doc(category: "Checkout") { + GRAPHQL_ERROR + INVALID + ORDER_NOT_FOUND + CHANNEL_INACTIVE + TAX_ERROR +} + +""" +Sets the customer as the owner of the checkout. + +Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER. +""" +type CheckoutCustomerAttach @doc(category: "Checkout") { + """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 @doc(category: "Checkout") { + """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 email address in the existing checkout object.""" +type CheckoutEmailUpdate @doc(category: "Checkout") { + """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 a CheckoutLine.""" +type CheckoutLineDelete @doc(category: "Checkout") { + """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 @doc(category: "Checkout") { + """An updated checkout.""" + checkout: Checkout + errors: [CheckoutError!]! +} + +""" +Adds a checkout line to the existing checkout.If line was already in checkout, its quantity will be increased. +""" +type CheckoutLinesAdd @doc(category: "Checkout") { + """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 checkout line in the existing checkout.""" +type CheckoutLinesUpdate @doc(category: "Checkout") { + """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 CheckoutLineUpdateInput @doc(category: "Checkout") { + """ + 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. + """ + price: PositiveDecimal + + """ + ID of the line. + + Added in Saleor 3.6. + """ + lineId: ID +} + +"""Remove a gift card or a voucher from a checkout.""" +type CheckoutRemovePromoCode @doc(category: "Checkout") { + """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!]! +} + +"""Create a new payment for given checkout.""" +type CheckoutPaymentCreate @doc(category: "Checkout") { + """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!]! +} + +input PaymentInput @doc(category: "Payments") { + """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 = NONE + + """ + User public metadata. + + Added in Saleor 3.1. + """ + metadata: [MetadataInput!] +} + +"""Enum representing the type of a payment storage in a gateway.""" +enum StorePaymentMethodEnum @doc(category: "Payments") { + """ + 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 +} + +"""Update shipping address in the existing checkout.""" +type CheckoutShippingAddressUpdate @doc(category: "Checkout") { + """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 @doc(category: "Checkout") { + """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. +""" +type CheckoutDeliveryMethodUpdate @doc(category: "Checkout") { + """An updated checkout.""" + checkout: Checkout + errors: [CheckoutError!]! +} + +"""Update language code in the existing checkout.""" +type CheckoutLanguageCodeUpdate @doc(category: "Checkout") { + """An updated checkout.""" + checkout: Checkout + checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [CheckoutError!]! +} + +""" +Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. + +Added in Saleor 3.2. +""" +type OrderCreateFromCheckout @doc(category: "Checkout") { + """Placed order.""" + order: Order + errors: [OrderCreateFromCheckoutError!]! +} + +type OrderCreateFromCheckoutError @doc(category: "Checkout") { + """ + 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 @doc(category: "Orders") { + 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 +} + +""" +Creates new channel. + +Requires one of the following permissions: MANAGE_CHANNELS. +""" +type ChannelCreate @doc(category: "Channels") { + channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ChannelError!]! + channel: Channel +} + +type ChannelError @doc(category: "Channels") { + """ + 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 @doc(category: "Channels") { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + CHANNELS_CURRENCY_MUST_BE_THE_SAME + CHANNEL_WITH_ORDERS + DUPLICATED_INPUT_ITEM +} + +input ChannelCreateInput @doc(category: "Channels") { + """isActive flag.""" + isActive: Boolean + + """ + The channel stock settings. + + Added in Saleor 3.7. + """ + 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. + """ + addWarehouses: [ID!] + + """ + The channel order settings + + Added in Saleor 3.12. + """ + orderSettings: OrderSettingsInput + + """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. + """ + defaultCountry: CountryCode! +} + +input StockSettingsInput @doc(category: "Products") { + """ + Allocation strategy options. Strategy defines the preference of warehouses for allocations and reservations. + """ + allocationStrategy: AllocationStrategyEnum! +} + +input OrderSettingsInput @doc(category: "Orders") { + """ + When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. By default set to True + """ + automaticallyConfirmAllNewOrders: Boolean + + """ + When enabled, all non-shippable gift card orders will be fulfilled automatically. By defualt set to True. + """ + automaticallyFulfillNonShippableGiftCard: Boolean + + """ + Expiration time in minutes. Default null - means do not expire any orders. Enter 0 or null to disable. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + expireOrdersAfter: Minute + + """ + The time in days after expired orders will be deleted.Allowed range is from 1 to 120. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + deleteExpiredOrdersAfter: Day + + """ + Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. + `PAYMENT_FLOW` - [default option] creates the `Payment` object. + `TRANSACTION_FLOW` - creates the `TransactionItem` object. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + markAsPaidStrategy: MarkAsPaidStrategyEnum + + """ + Determine the transaction flow strategy to be used. Include the selected option in the payload sent to the payment app, as a requested action for the transaction. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + defaultTransactionFlowStrategy: TransactionFlowStrategyEnum +} + +""" +Update a channel. + +Requires one of the following permissions: MANAGE_CHANNELS. +Requires one of the following permissions when updating only orderSettings field: MANAGE_CHANNELS, MANAGE_ORDERS. +""" +type ChannelUpdate @doc(category: "Channels") { + channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ChannelError!]! + channel: Channel +} + +input ChannelUpdateInput @doc(category: "Channels") { + """isActive flag.""" + isActive: Boolean + + """ + The channel stock settings. + + Added in Saleor 3.7. + """ + 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. + """ + addWarehouses: [ID!] + + """ + The channel order settings + + Added in Saleor 3.12. + """ + orderSettings: OrderSettingsInput + + """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. + """ + removeWarehouses: [ID!] +} + +""" +Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. + +Requires one of the following permissions: MANAGE_CHANNELS. +""" +type ChannelDelete @doc(category: "Channels") { + channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ChannelError!]! + channel: Channel +} + +input ChannelDeleteInput @doc(category: "Channels") { + """ID of channel to migrate orders from origin channel.""" + channelId: ID! +} + +""" +Activate a channel. + +Requires one of the following permissions: MANAGE_CHANNELS. +""" +type ChannelActivate @doc(category: "Channels") { + """Activated channel.""" + channel: Channel + channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ChannelError!]! +} + +""" +Deactivate a channel. + +Requires one of the following permissions: MANAGE_CHANNELS. +""" +type ChannelDeactivate @doc(category: "Channels") { + """Deactivated channel.""" + channel: Channel + channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [ChannelError!]! +} + +""" +Reorder the warehouses of a channel. + +Added in Saleor 3.7. + +Requires one of the following permissions: MANAGE_CHANNELS. +""" +type ChannelReorderWarehouses @doc(category: "Channels") { + """Channel within the warehouses are reordered.""" + channel: Channel + errors: [ChannelError!]! +} + +"""Creates an attribute.""" +type AttributeCreate @doc(category: "Attributes") { + attribute: Attribute + attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AttributeError!]! +} + +type AttributeError @doc(category: "Attributes") { + """ + 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 @doc(category: "Attributes") { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +input AttributeCreateInput @doc(category: "Attributes") { + """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. + + DEPRECATED: this field will be removed in Saleor 4.0. + """ + filterableInStorefront: Boolean + + """Whether the attribute can be filtered in dashboard.""" + filterableInDashboard: Boolean + + """ + The position of the attribute in the storefront navigation (0 by default). + + DEPRECATED: this field will be removed in Saleor 4.0. + """ + storefrontSearchPosition: Int + + """ + Whether the attribute can be displayed in the admin product list. + + DEPRECATED: this field will be removed in Saleor 4.0. + """ + availableInGrid: Boolean + + """ + External ID of this attribute. + + Added in Saleor 3.10. + """ + externalReference: String +} + +input AttributeValueCreateInput @doc(category: "Attributes") { + """ + 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 + + """ + External ID of this attribute value. + + Added in Saleor 3.10. + """ + externalReference: String + + """Name of a value displayed in the interface.""" + name: String! +} + +""" +Deletes an attribute. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type AttributeDelete @doc(category: "Attributes") { + attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AttributeError!]! + attribute: Attribute +} + +""" +Updates attribute. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type AttributeUpdate @doc(category: "Attributes") { + attribute: Attribute + attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AttributeError!]! +} + +input AttributeUpdateInput @doc(category: "Attributes") { + """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. + + DEPRECATED: this field will be removed in Saleor 4.0. + """ + filterableInStorefront: Boolean + + """Whether the attribute can be filtered in dashboard.""" + filterableInDashboard: Boolean + + """ + The position of the attribute in the storefront navigation (0 by default). + + DEPRECATED: this field will be removed in Saleor 4.0. + """ + storefrontSearchPosition: Int + + """ + Whether the attribute can be displayed in the admin product list. + + DEPRECATED: this field will be removed in Saleor 4.0. + """ + availableInGrid: Boolean + + """ + External ID of this product. + + Added in Saleor 3.10. + """ + externalReference: String +} + +input AttributeValueUpdateInput @doc(category: "Attributes") { + """ + 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 + + """ + External ID of this attribute value. + + Added in Saleor 3.10. + """ + externalReference: String + + """Name of a value displayed in the interface.""" + name: String +} + +""" +Creates/updates translations for an attribute. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type AttributeTranslate @doc(category: "Attributes") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + attribute: Attribute +} + +""" +Creates/updates translations for attributes. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type AttributeBulkTranslate @doc(category: "Attributes") { + """Returns how many translations were created/updated.""" + count: Int! + + """List of the translations.""" + results: [AttributeBulkTranslateResult!]! + errors: [AttributeBulkTranslateError!]! +} + +type AttributeBulkTranslateResult @doc(category: "Attributes") { + """Attribute translation data.""" + translation: AttributeTranslation + + """List of errors occurred on translation attempt.""" + errors: [AttributeBulkTranslateError!] +} + +type AttributeBulkTranslateError { + """ + Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + path: String + + """The error message.""" + message: String + + """The error code.""" + code: AttributeTranslateErrorCode! +} + +"""An enumeration.""" +enum AttributeTranslateErrorCode @doc(category: "Attributes") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED +} + +input AttributeBulkTranslateInput @doc(category: "Attributes") { + """Attribute ID.""" + id: ID + + """External reference of an attribute.""" + externalReference: String + + """Translation language code.""" + languageCode: LanguageCodeEnum! + + """Translation fields.""" + translationFields: NameTranslationInput! +} + +""" +Deletes attributes. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type AttributeBulkDelete @doc(category: "Attributes") { + """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!]! +} + +""" +Deletes values of attributes. + +Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. +""" +type AttributeValueBulkDelete @doc(category: "Attributes") { + """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!]! +} + +""" +Creates a value for an attribute. + +Requires one of the following permissions: MANAGE_PRODUCTS. +""" +type AttributeValueCreate @doc(category: "Attributes") { + """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 +} + +""" +Deletes a value of an attribute. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type AttributeValueDelete @doc(category: "Attributes") { + """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 +} + +""" +Updates value of an attribute. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type AttributeValueUpdate @doc(category: "Attributes") { + """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 +} + +""" +Creates/updates translations for attributes values. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type AttributeValueBulkTranslate @doc(category: "Attributes") { + """Returns how many translations were created/updated.""" + count: Int! + + """List of the translations.""" + results: [AttributeValueBulkTranslateResult!]! + errors: [AttributeValueBulkTranslateError!]! +} + +type AttributeValueBulkTranslateResult @doc(category: "Attributes") { + """Attribute value translation data.""" + translation: AttributeValueTranslation + + """List of errors occurred on translation attempt.""" + errors: [AttributeValueBulkTranslateError!] +} + +type AttributeValueBulkTranslateError { + """ + Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + path: String + + """The error message.""" + message: String + + """The error code.""" + code: AttributeValueTranslateErrorCode! +} + +"""An enumeration.""" +enum AttributeValueTranslateErrorCode @doc(category: "Attributes") { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED +} + +input AttributeValueBulkTranslateInput @doc(category: "Attributes") { + """Attribute value ID.""" + id: ID + + """External reference of an attribute value.""" + externalReference: String + + """Translation language code.""" + languageCode: LanguageCodeEnum! + + """Translation fields.""" + translationFields: AttributeValueTranslationInput! +} + +input AttributeValueTranslationInput { + name: String + + """ + Translated text. + + Rich text format. For reference see https://editorjs.io/ + """ + richText: JSONString + + """Translated text.""" + plainText: String +} + +""" +Creates/updates translations for an attribute value. + +Requires one of the following permissions: MANAGE_TRANSLATIONS. +""" +type AttributeValueTranslate @doc(category: "Attributes") { + translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [TranslationError!]! + attributeValue: AttributeValue +} + +""" +Reorder the values of an attribute. + +Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. +""" +type AttributeReorderValues @doc(category: "Attributes") { + """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!]! +} + +""" +Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. +""" +type AppCreate @doc(category: "Apps") { + """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 +} + +type AppError @doc(category: "Apps") { + """ + 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 @doc(category: "Apps") { + FORBIDDEN + GRAPHQL_ERROR + INVALID + INVALID_STATUS + INVALID_PERMISSION + INVALID_URL_FORMAT + INVALID_MANIFEST_FORMAT + INVALID_CUSTOM_HEADERS + MANIFEST_URL_CANT_CONNECT + NOT_FOUND + REQUIRED + UNIQUE + OUT_OF_SCOPE_APP + OUT_OF_SCOPE_PERMISSION + UNSUPPORTED_SALEOR_VERSION +} + +input AppInput @doc(category: "Apps") { + """Name of the app.""" + name: String + + """List of permission code names to assign to this app.""" + permissions: [PermissionEnum!] +} + +""" +Updates an existing app. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppUpdate @doc(category: "Apps") { + 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 @doc(category: "Apps") { + appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AppError!]! + app: App +} + +""" +Creates a new token. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppTokenCreate @doc(category: "Apps") { + """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 +} + +input AppTokenInput @doc(category: "Apps") { + """Name of the token.""" + name: String + + """ID of app.""" + app: ID! +} + +""" +Deletes an authentication token assigned to app. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppTokenDelete @doc(category: "Apps") { + appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AppError!]! + appToken: AppToken +} + +"""Verify provided app token.""" +type AppTokenVerify @doc(category: "Apps") { + """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!]! +} + +""" +Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. +""" +type AppInstall @doc(category: "Apps") { + appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AppError!]! + appInstallation: AppInstallation +} + +input AppInstallInput @doc(category: "Apps") { + """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!] +} + +""" +Retry failed installation of new app. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppRetryInstall @doc(category: "Apps") { + appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AppError!]! + appInstallation: AppInstallation +} + +""" +Delete failed installation. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppDeleteFailedInstallation @doc(category: "Apps") { + appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AppError!]! + appInstallation: AppInstallation +} + +""" +Fetch and validate manifest. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppFetchManifest @doc(category: "Apps") { + manifest: Manifest + appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AppError!]! +} + +"""The manifest definition.""" +type Manifest @doc(category: "Apps") { + 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. + """ + webhooks: [AppManifestWebhook!]! + + """ + The audience that will be included in all JWT tokens for the app. + + Added in Saleor 3.8. + """ + audience: String + + """ + Determines the app's required Saleor version as semver range. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + requiredSaleorVersion: AppManifestRequiredSaleorVersion + + """ + The App's author name. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + author: String + + """ + App's brand data. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + brand: AppManifestBrand +} + +type AppManifestExtension @doc(category: "Apps") { + """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 @doc(category: "Apps") { + """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! +} + +type AppManifestRequiredSaleorVersion @doc(category: "Apps") { + """ + Required Saleor version as semver range. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + constraint: String! + + """ + Informs if the Saleor version matches the required one. + + Added in Saleor 3.13. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + satisfied: Boolean! +} + +""" +Represents the app's manifest brand data. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type AppManifestBrand @doc(category: "Apps") { + """ + App's logos details. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + logo: AppManifestBrandLogo! +} + +""" +Represents the app's manifest brand data. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type AppManifestBrandLogo @doc(category: "Apps") { + """ + Data URL with a base64 encoded logo image. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + default( + """ + Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended). + """ + size: Int + + """ + The format of the image. When not provided, format of the original image will be used. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + format: IconThumbnailFormatEnum = ORIGINAL + ): String! +} + +""" +Activate the app. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppActivate @doc(category: "Apps") { + 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 @doc(category: "Apps") { + appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AppError!]! + app: App +} + +"""Create JWT token.""" +type CreateToken @doc(category: "Authentication") { + """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!]! +} + +"""Represents errors in account mutations.""" +type AccountError @doc(category: "Users") { + """ + 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 @doc(category: "Users") { + 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 + PASSWORD_RESET_ALREADY_REQUESTED + 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 +} + +""" +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 @doc(category: "Authentication") { + """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!]! +} + +"""Verify JWT token.""" +type VerifyToken @doc(category: "Authentication") { + """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!]! +} + +""" +The `GenericScalar` scalar type represents a generic +GraphQL scalar value that could be: +String, Boolean, Int, Float, List or Object. +""" +scalar GenericScalar + +""" +Deactivate all JWT tokens of the currently authenticated user. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type DeactivateAllUserTokens @doc(category: "Authentication") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! +} + +"""Prepare external authentication URL for user by custom plugin.""" +type ExternalAuthenticationUrl @doc(category: "Authentication") { + """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!]! +} + +"""Obtain external access tokens for user by custom plugin.""" +type ExternalObtainAccessTokens @doc(category: "Authentication") { + """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 @doc(category: "Authentication") { + """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!]! +} + +"""Logout user by custom plugin.""" +type ExternalLogout @doc(category: "Authentication") { + """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!]! +} + +"""Verify external authentication data by plugin.""" +type ExternalVerify @doc(category: "Authentication") { + """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!]! +} + +"""Sends an email with the account password modification link.""" +type RequestPasswordReset @doc(category: "Users") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! +} + +"""Confirm user account with token sent by email during registration.""" +type ConfirmAccount @doc(category: "Users") { + """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!]! +} + +""" +Sets the user's password from the token sent by email using the RequestPasswordReset mutation. +""" +type SetPassword @doc(category: "Users") { + """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!]! +} + +""" +Change the password of the logged in user. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type PasswordChange @doc(category: "Users") { + """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!]! +} + +""" +Request email change of the logged in user. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type RequestEmailChange @doc(category: "Users") { + """A user instance.""" + 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 @doc(category: "Users") { + """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!]! +} + +""" +Create a new address for the customer. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type AccountAddressCreate @doc(category: "Users") { + """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 +} + +""" +Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. +""" +type AccountAddressUpdate @doc(category: "Users") { + """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 +} + +""" +Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. +""" +type AccountAddressDelete @doc(category: "Users") { + """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 +} + +""" +Sets a default address for the authenticated user. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type AccountSetDefaultAddress @doc(category: "Users") { + """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!]! +} + +"""Register a new user.""" +type AccountRegister @doc(category: "Users") { + """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 +} + +"""Fields required to create a user.""" +input AccountRegisterInput @doc(category: "Users") { + """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 +} + +""" +Updates the account of the logged-in user. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type AccountUpdate @doc(category: "Users") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! + user: User +} + +"""Fields required to update the user.""" +input AccountInput @doc(category: "Users") { + """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 + + """ + Fields required to update the user metadata. + + Added in Saleor 3.14. + """ + metadata: [MetadataInput!] +} + +""" +Sends an email with the account removal link for the logged-in user. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type AccountRequestDeletion @doc(category: "Users") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! +} + +""" +Remove user account. + +Requires one of the following permissions: AUTHENTICATED_USER. +""" +type AccountDelete @doc(category: "Users") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! + user: User +} + +""" +Creates user address. + +Requires one of the following permissions: MANAGE_USERS. +""" +type AddressCreate @doc(category: "Users") { + """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 +} + +""" +Updates an address. + +Requires one of the following permissions: MANAGE_USERS. +""" +type AddressUpdate @doc(category: "Users") { + """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 +} + +""" +Deletes an address. + +Requires one of the following permissions: MANAGE_USERS. +""" +type AddressDelete @doc(category: "Users") { + """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 +} + +""" +Sets a default address for the given user. + +Requires one of the following permissions: MANAGE_USERS. +""" +type AddressSetDefault @doc(category: "Users") { + """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!]! +} + +""" +Creates a new customer. + +Requires one of the following permissions: MANAGE_USERS. +""" +type CustomerCreate @doc(category: "Users") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! + user: User +} + +input UserCreateInput @doc(category: "Users") { + """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 + + """ + Fields required to update the user metadata. + + Added in Saleor 3.14. + """ + metadata: [MetadataInput!] + + """ + Fields required to update the user private metadata. + + Added in Saleor 3.14. + """ + privateMetadata: [MetadataInput!] + + """User language code.""" + languageCode: LanguageCodeEnum + + """ + External ID of the customer. + + Added in Saleor 3.10. + """ + externalReference: String + + """ + 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 +} + +""" +Updates an existing customer. + +Requires one of the following permissions: MANAGE_USERS. +""" +type CustomerUpdate @doc(category: "Users") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! + user: User +} + +input CustomerInput @doc(category: "Users") { + """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 + + """ + Fields required to update the user metadata. + + Added in Saleor 3.14. + """ + metadata: [MetadataInput!] + + """ + Fields required to update the user private metadata. + + Added in Saleor 3.14. + """ + privateMetadata: [MetadataInput!] + + """User language code.""" + languageCode: LanguageCodeEnum + + """ + External ID of the customer. + + Added in Saleor 3.10. + """ + externalReference: String +} + +""" +Deletes a customer. + +Requires one of the following permissions: MANAGE_USERS. +""" +type CustomerDelete @doc(category: "Users") { + accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [AccountError!]! + user: User +} + +""" +Deletes customers. + +Requires one of the following permissions: MANAGE_USERS. +""" +type CustomerBulkDelete @doc(category: "Users") { + """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!]! +} + +""" +Updates customers. + +Added in Saleor 3.13. + +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. +""" +type CustomerBulkUpdate @doc(category: "Users") { + """Returns how many objects were created.""" + count: Int! + + """List of the updated customers.""" + results: [CustomerBulkResult!]! + errors: [CustomerBulkUpdateError!]! +} + +type CustomerBulkResult @doc(category: "Users") { + """Customer data.""" + customer: User + + """List of errors that occurred during the update attempt.""" + errors: [CustomerBulkUpdateError!] +} + +type CustomerBulkUpdateError @doc(category: "Users") { + """ + Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + path: String + + """The error message.""" + message: String + + """The error code.""" + code: CustomerBulkUpdateErrorCode! +} + +"""An enumeration.""" +enum CustomerBulkUpdateErrorCode @doc(category: "Users") { + BLANK + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + REQUIRED + UNIQUE + NOT_FOUND + MAX_LENGTH +} + +input CustomerBulkUpdateInput @doc(category: "Users") { + """ID of a customer to update.""" + id: ID + + """External ID of a customer to update.""" + externalReference: String + + """Fields required to update a customer.""" + input: CustomerInput! +} + +""" +Creates a new staff user. Apps are not allowed to perform this mutation. + +Requires one of the following permissions: MANAGE_STAFF. +""" +type StaffCreate @doc(category: "Users") { + staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [StaffError!]! + user: User +} + +type StaffError @doc(category: "Users") { + """ + 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!] +} + +"""Fields required to create a staff user.""" +input StaffCreateInput @doc(category: "Users") { + """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 + + """ + Fields required to update the user metadata. + + Added in Saleor 3.14. + """ + metadata: [MetadataInput!] + + """ + Fields required to update the user private metadata. + + Added in Saleor 3.14. + """ + privateMetadata: [MetadataInput!] + + """List of permission group IDs to which user should be assigned.""" + addGroups: [ID!] + + """ + URL of a view where users should be redirected to set the password. URL in RFC 1808 format. + """ + redirectUrl: String +} + +""" +Updates an existing staff user. Apps are not allowed to perform this mutation. + +Requires one of the following permissions: MANAGE_STAFF. +""" +type StaffUpdate @doc(category: "Users") { + staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [StaffError!]! + user: User +} + +"""Fields required to update a staff user.""" +input StaffUpdateInput @doc(category: "Users") { + """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 + + """ + Fields required to update the user metadata. + + Added in Saleor 3.14. + """ + metadata: [MetadataInput!] + + """ + Fields required to update the user private metadata. + + Added in Saleor 3.14. + """ + privateMetadata: [MetadataInput!] + + """List of permission group IDs to which user should be assigned.""" + addGroups: [ID!] + + """List of permission group IDs from which user should be unassigned.""" + removeGroups: [ID!] +} + +""" +Deletes a staff user. Apps are not allowed to perform this mutation. + +Requires one of the following permissions: MANAGE_STAFF. +""" +type StaffDelete @doc(category: "Users") { + staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [StaffError!]! + user: User +} + +""" +Deletes staff users. Apps are not allowed to perform this mutation. + +Requires one of the following permissions: MANAGE_STAFF. +""" +type StaffBulkDelete @doc(category: "Users") { + """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!]! +} + +""" +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 @doc(category: "Users") { + """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!]! +} + +""" +Deletes a user avatar. Only for staff members. + +Requires one of the following permissions: AUTHENTICATED_STAFF_USER. +""" +type UserAvatarDelete @doc(category: "Users") { + """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 @doc(category: "Users") { + """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!]! +} + +""" +Create new permission group. Apps are not allowed to perform this mutation. + +Requires one of the following permissions: MANAGE_STAFF. +""" +type PermissionGroupCreate @doc(category: "Users") { + permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PermissionGroupError!]! + group: Group +} + +type PermissionGroupError @doc(category: "Users") { + """ + 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!] + + """List of chnnels IDs which causes the error.""" + channels: [ID!] +} + +"""An enumeration.""" +enum PermissionGroupErrorCode @doc(category: "Users") { + REQUIRED + UNIQUE + ASSIGN_NON_STAFF_MEMBER + DUPLICATED_INPUT_ITEM + CANNOT_REMOVE_FROM_LAST_GROUP + LEFT_NOT_MANAGEABLE_PERMISSION + OUT_OF_SCOPE_PERMISSION + OUT_OF_SCOPE_USER + OUT_OF_SCOPE_CHANNEL +} + +input PermissionGroupCreateInput @doc(category: "Users") { + """List of permission code names to assign to this group.""" + addPermissions: [PermissionEnum!] + + """List of users to assign to this group.""" + addUsers: [ID!] + + """ + List of channels to assign to this group. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + addChannels: [ID!] + + """Group name.""" + name: String! + + """ + Determine if the group has restricted access to channels. DEFAULT: False + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + restrictedAccessToChannels: Boolean = false +} + +""" +Update permission group. Apps are not allowed to perform this mutation. + +Requires one of the following permissions: MANAGE_STAFF. +""" +type PermissionGroupUpdate @doc(category: "Users") { + permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PermissionGroupError!]! + group: Group +} + +input PermissionGroupUpdateInput @doc(category: "Users") { + """List of permission code names to assign to this group.""" + addPermissions: [PermissionEnum!] + + """List of users to assign to this group.""" + addUsers: [ID!] + + """ + List of channels to assign to this group. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + addChannels: [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!] + + """ + List of channels to unassign from this group. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + removeChannels: [ID!] + + """ + Determine if the group has restricted access to channels. + + Added in Saleor 3.14. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + restrictedAccessToChannels: Boolean +} + +""" +Delete permission group. Apps are not allowed to perform this mutation. + +Requires one of the following permissions: MANAGE_STAFF. +""" +type PermissionGroupDelete @doc(category: "Users") { + permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + errors: [PermissionGroupError!]! + group: Group +} + +type Subscription { + """ + Look up subscription event. + + Added in Saleor 3.2. + """ + event: Event +} + +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 @doc(category: "Apps") +} + +union IssuingPrincipal = App | User + +"""An enumeration.""" +enum DistanceUnitsEnum { + CM + M + KM + FT + YD + INCH +} + +"""An enumeration.""" +enum AreaUnitsEnum { + SQ_CM + SQ_M + SQ_KM + SQ_FT + SQ_YD + SQ_INCH +} + +"""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 +} + +""" +Event sent when new address is created. + +Added in Saleor 3.5. +""" +type AddressCreated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when address is updated. + +Added in Saleor 3.5. +""" +type AddressUpdated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when address is deleted. + +Added in Saleor 3.5. +""" +type AddressDeleted implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when new app is installed. + +Added in Saleor 3.4. +""" +type AppInstalled implements Event @doc(category: "Apps") { + """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 +} + +""" +Event sent when app is updated. + +Added in Saleor 3.4. +""" +type AppUpdated implements Event @doc(category: "Apps") { + """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 +} + +""" +Event sent when app is deleted. + +Added in Saleor 3.4. +""" +type AppDeleted implements Event @doc(category: "Apps") { + """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 +} + +""" +Event sent when app status has changed. + +Added in Saleor 3.4. +""" +type AppStatusChanged implements Event @doc(category: "Apps") { + """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 +} + +""" +Event sent when new attribute is created. + +Added in Saleor 3.5. +""" +type AttributeCreated implements Event @doc(category: "Attributes") { + """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 +} + +""" +Event sent when attribute is updated. + +Added in Saleor 3.5. +""" +type AttributeUpdated implements Event @doc(category: "Attributes") { + """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 +} + +""" +Event sent when attribute is deleted. + +Added in Saleor 3.5. +""" +type AttributeDeleted implements Event @doc(category: "Attributes") { + """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 +} + +""" +Event sent when new attribute value is created. + +Added in Saleor 3.5. +""" +type AttributeValueCreated implements Event @doc(category: "Attributes") { + """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 +} + +""" +Event sent when attribute value is updated. + +Added in Saleor 3.5. +""" +type AttributeValueUpdated implements Event @doc(category: "Attributes") { + """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 +} + +""" +Event sent when attribute value is deleted. + +Added in Saleor 3.5. +""" +type AttributeValueDeleted implements Event @doc(category: "Attributes") { + """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 +} + +""" +Event sent when new category is created. + +Added in Saleor 3.2. +""" +type CategoryCreated implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when category is updated. + +Added in Saleor 3.2. +""" +type CategoryUpdated implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when category is deleted. + +Added in Saleor 3.2. +""" +type CategoryDeleted implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when new channel is created. + +Added in Saleor 3.2. +""" +type ChannelCreated implements Event @doc(category: "Channels") { + """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 channel is updated. + +Added in Saleor 3.2. +""" +type ChannelUpdated implements Event @doc(category: "Channels") { + """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 channel is deleted. + +Added in Saleor 3.2. +""" +type ChannelDeleted implements Event @doc(category: "Channels") { + """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 channel status has changed. + +Added in Saleor 3.2. +""" +type ChannelStatusChanged implements Event @doc(category: "Channels") { + """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 gift card is created. + +Added in Saleor 3.2. +""" +type GiftCardCreated implements Event @doc(category: "Gift cards") { + """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 gift card is updated. + +Added in Saleor 3.2. +""" +type GiftCardUpdated implements Event @doc(category: "Gift cards") { + """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 gift card is deleted. + +Added in Saleor 3.2. +""" +type GiftCardDeleted implements Event @doc(category: "Gift cards") { + """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 gift card is e-mailed. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type GiftCardSent implements Event @doc(category: "Gift cards") { + """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 + + """Slug of a channel for which this gift card email was sent.""" + channel: String + + """E-mail address to which gift card was sent.""" + sentToEmail: String +} + +""" +Event sent when gift card status has changed. + +Added in Saleor 3.2. +""" +type GiftCardStatusChanged implements Event @doc(category: "Gift cards") { + """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 gift card metadata is updated. + +Added in Saleor 3.8. +""" +type GiftCardMetadataUpdated implements Event @doc(category: "Gift cards") { + """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 menu is created. + +Added in Saleor 3.4. +""" +type MenuCreated implements Event @doc(category: "Menu") { + """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 +} + +""" +Event sent when menu is updated. + +Added in Saleor 3.4. +""" +type MenuUpdated implements Event @doc(category: "Menu") { + """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 +} + +""" +Event sent when menu is deleted. + +Added in Saleor 3.4. +""" +type MenuDeleted implements Event @doc(category: "Menu") { + """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 +} + +""" +Event sent when new menu item is created. + +Added in Saleor 3.4. +""" +type MenuItemCreated implements Event @doc(category: "Menu") { + """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 +} + +""" +Event sent when menu item is updated. + +Added in Saleor 3.4. +""" +type MenuItemUpdated implements Event @doc(category: "Menu") { + """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 +} + +""" +Event sent when menu item is deleted. + +Added in Saleor 3.4. +""" +type MenuItemDeleted implements Event @doc(category: "Menu") { + """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 +} + +""" +Event sent when new order is created. + +Added in Saleor 3.2. +""" +type OrderCreated implements Event @doc(category: "Orders") { + """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. +""" +type OrderUpdated implements Event @doc(category: "Orders") { + """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 confirmed. + +Added in Saleor 3.2. +""" +type OrderConfirmed implements Event @doc(category: "Orders") { + """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. +""" +type OrderFullyPaid implements Event @doc(category: "Orders") { + """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 +} + +""" +Payment has been made. The order may be partially or fully paid. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type OrderPaid implements Event @doc(category: "Orders") { + """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 +} + +""" +The order received a refund. The order may be partially or fully refunded. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type OrderRefunded implements Event @doc(category: "Orders") { + """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 +} + +""" +The order is fully refunded. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type OrderFullyRefunded implements Event @doc(category: "Orders") { + """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 fulfilled. + +Added in Saleor 3.2. +""" +type OrderFulfilled implements Event @doc(category: "Orders") { + """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 canceled. + +Added in Saleor 3.2. +""" +type OrderCancelled implements Event @doc(category: "Orders") { + """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 becomes expired. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type OrderExpired implements Event @doc(category: "Orders") { + """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 metadata is updated. + +Added in Saleor 3.8. +""" +type OrderMetadataUpdated implements Event @doc(category: "Orders") { + """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 orders are imported. + +Added in Saleor 3.14. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type OrderBulkCreated 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 orders the event relates to.""" + orders: [Order!] +} + +""" +Event sent when new draft order is created. + +Added in Saleor 3.2. +""" +type DraftOrderCreated implements Event @doc(category: "Orders") { + """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 draft order is updated. + +Added in Saleor 3.2. +""" +type DraftOrderUpdated implements Event @doc(category: "Orders") { + """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 draft order is deleted. + +Added in Saleor 3.2. +""" +type DraftOrderDeleted implements Event @doc(category: "Orders") { + """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 product is created. + +Added in Saleor 3.2. +""" +type ProductCreated implements Event @doc(category: "Products") { + """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 product is updated. + +Added in Saleor 3.2. +""" +type ProductUpdated implements Event @doc(category: "Products") { + """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 product is deleted. + +Added in Saleor 3.2. +""" +type ProductDeleted implements Event @doc(category: "Products") { + """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 product metadata is updated. + +Added in Saleor 3.8. +""" +type ProductMetadataUpdated implements Event @doc(category: "Products") { + """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 media is created. + +Added in Saleor 3.12. +""" +type ProductMediaCreated implements Event @doc(category: "Products") { + """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 media the event relates to.""" + productMedia: ProductMedia +} + +""" +Event sent when product media is updated. + +Added in Saleor 3.12. +""" +type ProductMediaUpdated implements Event @doc(category: "Products") { + """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 media the event relates to.""" + productMedia: ProductMedia +} + +""" +Event sent when product media is deleted. + +Added in Saleor 3.12. +""" +type ProductMediaDeleted implements Event @doc(category: "Products") { + """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 media the event relates to.""" + productMedia: ProductMedia +} + +""" +Event sent when new product variant is created. + +Added in Saleor 3.2. +""" +type ProductVariantCreated implements Event @doc(category: "Products") { + """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 updated. + +Added in Saleor 3.2. +""" +type ProductVariantUpdated implements Event @doc(category: "Products") { + """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. +""" +type ProductVariantOutOfStock implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when product variant is back in stock. + +Added in Saleor 3.2. +""" +type ProductVariantBackInStock implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when product variant stock is updated. + +Added in Saleor 3.11. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type ProductVariantStockUpdated implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when product variant is deleted. + +Added in Saleor 3.2. +""" +type ProductVariantDeleted implements Event @doc(category: "Products") { + """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 metadata is updated. + +Added in Saleor 3.8. +""" +type ProductVariantMetadataUpdated implements Event @doc(category: "Products") { + """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 sale is created. + +Added in Saleor 3.2. +""" +type SaleCreated implements Event @doc(category: "Discounts") { + """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 +} + +""" +Event sent when sale is updated. + +Added in Saleor 3.2. +""" +type SaleUpdated implements Event @doc(category: "Discounts") { + """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 +} + +""" +Event sent when sale is deleted. + +Added in Saleor 3.2. +""" +type SaleDeleted implements Event @doc(category: "Discounts") { + """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 +} + +""" +The event informs about the start or end of the sale. + +Added in Saleor 3.5. +""" +type SaleToggle implements Event @doc(category: "Discounts") { + """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. + """ + sale( + """Slug of a channel for which the data should be returned.""" + channel: String + ): Sale +} + +""" +Event sent when invoice is requested. + +Added in Saleor 3.2. +""" +type InvoiceRequested implements Event @doc(category: "Orders") { + """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 + + """ + Order related to the invoice. + + Added in Saleor 3.10. + """ + order: Order! +} + +""" +Event sent when invoice is deleted. + +Added in Saleor 3.2. +""" +type InvoiceDeleted implements Event @doc(category: "Orders") { + """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 + + """ + Order related to the invoice. + + Added in Saleor 3.10. + """ + order: Order +} + +""" +Event sent when invoice is sent. + +Added in Saleor 3.2. +""" +type InvoiceSent implements Event @doc(category: "Orders") { + """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 + + """ + Order related to the invoice. + + Added in Saleor 3.10. + """ + order: Order +} + +""" +Event sent when new fulfillment is created. + +Added in Saleor 3.4. +""" +type FulfillmentCreated implements Event @doc(category: "Orders") { + """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 fulfillment is canceled. + +Added in Saleor 3.4. +""" +type FulfillmentCanceled implements Event @doc(category: "Orders") { + """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 fulfillment is approved. + +Added in Saleor 3.7. +""" +type FulfillmentApproved implements Event @doc(category: "Orders") { + """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 fulfillment metadata is updated. + +Added in Saleor 3.8. +""" +type FulfillmentMetadataUpdated implements Event @doc(category: "Orders") { + """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 customer user is created. + +Added in Saleor 3.2. +""" +type CustomerCreated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when customer user is updated. + +Added in Saleor 3.2. +""" +type CustomerUpdated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when customer user metadata is updated. + +Added in Saleor 3.8. +""" +type CustomerMetadataUpdated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when new collection is created. + +Added in Saleor 3.2. +""" +type CollectionCreated implements Event @doc(category: "Products") { + """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 collection is updated. + +Added in Saleor 3.2. +""" +type CollectionUpdated implements Event @doc(category: "Products") { + """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 collection is deleted. + +Added in Saleor 3.2. +""" +type CollectionDeleted implements Event @doc(category: "Products") { + """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 collection metadata is updated. + +Added in Saleor 3.8. +""" +type CollectionMetadataUpdated implements Event @doc(category: "Products") { + """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 checkout is created. + +Added in Saleor 3.2. +""" +type CheckoutCreated implements Event @doc(category: "Checkout") { + """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 +} + +""" +Event sent when checkout is updated. + +Added in Saleor 3.2. +""" +type CheckoutUpdated implements Event @doc(category: "Checkout") { + """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 +} + +""" +Event sent when checkout is fully paid with transactions. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type CheckoutFullyPaid implements Event @doc(category: "Checkout") { + """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 +} + +""" +Event sent when checkout metadata is updated. + +Added in Saleor 3.8. +""" +type CheckoutMetadataUpdated implements Event @doc(category: "Checkout") { + """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 +} + +""" +Event sent when new page is created. + +Added in Saleor 3.2. +""" +type PageCreated implements Event @doc(category: "Pages") { + """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 page is updated. + +Added in Saleor 3.2. +""" +type PageUpdated implements Event @doc(category: "Pages") { + """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 page is deleted. + +Added in Saleor 3.2. +""" +type PageDeleted implements Event @doc(category: "Pages") { + """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 type is created. + +Added in Saleor 3.5. +""" +type PageTypeCreated implements Event @doc(category: "Pages") { + """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 +} + +""" +Event sent when page type is updated. + +Added in Saleor 3.5. +""" +type PageTypeUpdated implements Event @doc(category: "Pages") { + """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 +} + +""" +Event sent when page type is deleted. + +Added in Saleor 3.5. +""" +type PageTypeDeleted implements Event @doc(category: "Pages") { + """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 +} + +""" +Event sent when new permission group is created. + +Added in Saleor 3.6. +""" +type PermissionGroupCreated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when permission group is updated. + +Added in Saleor 3.6. +""" +type PermissionGroupUpdated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when permission group is deleted. + +Added in Saleor 3.6. +""" +type PermissionGroupDeleted implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when new shipping price is created. + +Added in Saleor 3.2. +""" +type ShippingPriceCreated implements Event @doc(category: "Shipping") { + """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 +} + +""" +Event sent when shipping price is updated. + +Added in Saleor 3.2. +""" +type ShippingPriceUpdated implements Event @doc(category: "Shipping") { + """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 +} + +""" +Event sent when shipping price is deleted. + +Added in Saleor 3.2. +""" +type ShippingPriceDeleted implements Event @doc(category: "Shipping") { + """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 +} + +""" +Event sent when new shipping zone is created. + +Added in Saleor 3.2. +""" +type ShippingZoneCreated implements Event @doc(category: "Shipping") { + """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. +""" +type ShippingZoneUpdated implements Event @doc(category: "Shipping") { + """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 deleted. + +Added in Saleor 3.2. +""" +type ShippingZoneDeleted implements Event @doc(category: "Shipping") { + """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 metadata is updated. + +Added in Saleor 3.8. +""" +type ShippingZoneMetadataUpdated implements Event @doc(category: "Shipping") { + """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 staff user is created. + +Added in Saleor 3.5. +""" +type StaffCreated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when staff user is updated. + +Added in Saleor 3.5. +""" +type StaffUpdated implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when staff user is deleted. + +Added in Saleor 3.5. +""" +type StaffDeleted implements Event @doc(category: "Users") { + """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 +} + +""" +Event sent when transaction action is requested. + +Added in Saleor 3.4. + +DEPRECATED: this subscription will be removed in Saleor 3.14 (Preview Feature). Use `TransactionChargeRequested`, `TransactionRefundRequested`, `TransactionCancelationRequested` instead. +""" +type TransactionActionRequest implements Event @doc(category: "Payments") { + """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.""" + transaction: TransactionItem + + """Requested action data.""" + action: TransactionAction! +} + +type TransactionAction @doc(category: "Payments") { + """Determines the action type.""" + actionType: TransactionActionEnum! + + """Transaction request amount. Null when action type is VOID.""" + amount: PositiveDecimal +} + +""" +Event sent when transaction item metadata is updated. + +Added in Saleor 3.8. +""" +type TransactionItemMetadataUpdated implements Event @doc(category: "Payments") { + """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.""" + transaction: TransactionItem +} + +""" +Event sent when new translation is created. + +Added in Saleor 3.2. +""" +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 +} + +union TranslationTypes = ProductTranslation | CollectionTranslation | CategoryTranslation | AttributeTranslation | AttributeValueTranslation | ProductVariantTranslation | PageTranslation | ShippingMethodTranslation | SaleTranslation | VoucherTranslation | MenuItemTranslation + +""" +Event sent when translation is updated. + +Added in Saleor 3.2. +""" +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 +} + +""" +Event sent when new voucher is created. + +Added in Saleor 3.4. +""" +type VoucherCreated implements Event @doc(category: "Discounts") { + """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 +} + +""" +Event sent when voucher is updated. + +Added in Saleor 3.4. +""" +type VoucherUpdated implements Event @doc(category: "Discounts") { + """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 +} + +""" +Event sent when voucher is deleted. + +Added in Saleor 3.4. +""" +type VoucherDeleted implements Event @doc(category: "Discounts") { + """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 +} + +""" +Event sent when voucher metadata is updated. + +Added in Saleor 3.8. +""" +type VoucherMetadataUpdated implements Event @doc(category: "Discounts") { + """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 +} + +""" +Event sent when new warehouse is created. + +Added in Saleor 3.4. +""" +type WarehouseCreated implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when warehouse is updated. + +Added in Saleor 3.4. +""" +type WarehouseUpdated implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when warehouse is deleted. + +Added in Saleor 3.4. +""" +type WarehouseDeleted implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when warehouse metadata is updated. + +Added in Saleor 3.8. +""" +type WarehouseMetadataUpdated implements Event @doc(category: "Products") { + """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 +} + +""" +Event sent when thumbnail is created. + +Added in Saleor 3.12. +""" +type ThumbnailCreated 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 + + """ + Thumbnail id. + + Added in Saleor 3.12. + """ + id: ID + + """ + Thumbnail url. + + Added in Saleor 3.12. + """ + url: String + + """ + Object the thumbnail refers to. + + Added in Saleor 3.12. + """ + objectId: ID + + """ + Original media url. + + Added in Saleor 3.12. + """ + mediaUrl: String +} + +""" +Authorize payment. + +Added in Saleor 3.6. +""" +type PaymentAuthorize implements Event @doc(category: "Payments") { + """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 +} + +""" +Capture payment. + +Added in Saleor 3.6. +""" +type PaymentCaptureEvent implements Event @doc(category: "Payments") { + """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 +} + +""" +Refund payment. + +Added in Saleor 3.6. +""" +type PaymentRefundEvent implements Event @doc(category: "Payments") { + """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 +} + +""" +Void payment. + +Added in Saleor 3.6. +""" +type PaymentVoidEvent implements Event @doc(category: "Payments") { + """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 +} + +""" +Confirm payment. + +Added in Saleor 3.6. +""" +type PaymentConfirmEvent implements Event @doc(category: "Payments") { + """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 +} + +""" +Process payment. + +Added in Saleor 3.6. +""" +type PaymentProcessEvent implements Event @doc(category: "Payments") { + """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 +} + +""" +List payment gateways. + +Added in Saleor 3.6. +""" +type PaymentListGateways implements Event @doc(category: "Payments") { + """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 +} + +""" +Event sent when transaction cancelation is requested. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type TransactionCancelationRequested implements Event @doc(category: "Payments") { + """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.""" + transaction: TransactionItem + + """Requested action data.""" + action: TransactionAction! +} + +""" +Event sent when transaction charge is requested. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type TransactionChargeRequested implements Event @doc(category: "Payments") { + """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.""" + transaction: TransactionItem + + """Requested action data.""" + action: TransactionAction! +} + +""" +Event sent when transaction refund is requested. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type TransactionRefundRequested implements Event @doc(category: "Payments") { + """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.""" + transaction: TransactionItem + + """Requested action data.""" + action: TransactionAction! +} + +""" +Filter shipping methods for order. + +Added in Saleor 3.6. +""" +type OrderFilterShippingMethods implements Event @doc(category: "Orders") { + """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. + """ + shippingMethods: [ShippingMethod!] +} + +""" +Filter shipping methods for checkout. + +Added in Saleor 3.6. +""" +type CheckoutFilterShippingMethods implements Event @doc(category: "Checkout") { + """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. + """ + shippingMethods: [ShippingMethod!] +} + +""" +List shipping methods for checkout. + +Added in Saleor 3.6. +""" +type ShippingListMethodsForCheckout implements Event @doc(category: "Checkout") { + """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. + """ + shippingMethods: [ShippingMethod!] +} + +""" +Synchronous webhook for calculating checkout/order taxes. + +Added in Saleor 3.7. +""" +type CalculateTaxes implements Event @doc(category: "Taxes") { + """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! +} + +"""Taxable object.""" +type TaxableObject @doc(category: "Taxes") { + """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 @doc(category: "Taxes") { + """The name of the discount.""" + name: String + + """The amount of the discount.""" + amount: Money! +} + +type TaxableObjectLine @doc(category: "Taxes") { + """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! +} + +union TaxSourceLine = CheckoutLine | OrderLine + +""" +Event sent when user wants to initialize the payment gateway. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type PaymentGatewayInitializeSession implements Event @doc(category: "Payments") { + """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 + + """Checkout or order""" + sourceObject: OrderOrCheckout! + + """Payment gateway data in JSON format, recieved from storefront.""" + data: JSON + + """Amount requested for initializing the payment gateway.""" + amount: PositiveDecimal +} + +union OrderOrCheckout = Checkout | Order + +""" +Event sent when user starts processing the payment. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type TransactionInitializeSession implements Event @doc(category: "Payments") { + """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.""" + transaction: TransactionItem! + + """Checkout or order""" + sourceObject: OrderOrCheckout! + + """Payment gateway data in JSON format, recieved from storefront.""" + data: JSON + + """Merchant reference assigned to this payment.""" + merchantReference: String! + + """Action to proceed for the transaction""" + action: TransactionProcessAction! +} + +type TransactionProcessAction @doc(category: "Payments") { + """Transaction amount to process.""" + amount: PositiveDecimal! + + """Currency of the amount.""" + currency: String! + actionType: TransactionFlowStrategyEnum! +} + +""" +Event sent when user has additional payment action to process. + +Added in Saleor 3.13. + +Note: this API is currently in Feature Preview and can be subject to changes at later point. +""" +type TransactionProcessSession implements Event @doc(category: "Payments") { + """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.""" + transaction: TransactionItem! + + """Checkout or order""" + sourceObject: OrderOrCheckout! + + """Payment gateway data in JSON format, recieved from storefront.""" + data: JSON + + """Merchant reference assigned to this payment.""" + merchantReference: String! + + """Action to proceed for the transaction""" + action: TransactionProcessAction! +} + +"""_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 | ProductMedia | Category | Collection | Order | PageType + +"""_Service manifest as defined by Federation spec.""" +type _Service { + sdl: String +} diff --git a/apps/orders-export/graphql/subscriptions/.gitkeep b/apps/orders-export/graphql/subscriptions/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/apps/orders-export/graphql/subscriptions/order-cancelled.graphql b/apps/orders-export/graphql/subscriptions/order-cancelled.graphql new file mode 100644 index 0000000..665dbfb --- /dev/null +++ b/apps/orders-export/graphql/subscriptions/order-cancelled.graphql @@ -0,0 +1,11 @@ +fragment OrderCancelledSubscriptionPayload on OrderCancelled { + order { + ...OrderBase + } +} + +subscription OrderCancelled { + event { + ...OrderCancelledSubscriptionPayload + } +} diff --git a/apps/orders-export/graphql/subscriptions/order-created.graphql b/apps/orders-export/graphql/subscriptions/order-created.graphql new file mode 100644 index 0000000..cb200c7 --- /dev/null +++ b/apps/orders-export/graphql/subscriptions/order-created.graphql @@ -0,0 +1,11 @@ +fragment OrderCreatedSubscriptionPayload on OrderCreated { + order { + ...OrderBase + } +} + +subscription OrderCreated { + event { + ...OrderCreatedSubscriptionPayload + } +} diff --git a/apps/orders-export/graphql/subscriptions/order-fully-paid.graphql b/apps/orders-export/graphql/subscriptions/order-fully-paid.graphql new file mode 100644 index 0000000..d381c7b --- /dev/null +++ b/apps/orders-export/graphql/subscriptions/order-fully-paid.graphql @@ -0,0 +1,11 @@ +fragment OrderFullyPaidSubscriptionPayload on OrderFullyPaid { + order { + ...OrderBase + } +} + +subscription OrderFullyPaid { + event { + ...OrderFullyPaidSubscriptionPayload + } +} diff --git a/apps/orders-export/graphql/subscriptions/order-refunded.graphql b/apps/orders-export/graphql/subscriptions/order-refunded.graphql new file mode 100644 index 0000000..4679717 --- /dev/null +++ b/apps/orders-export/graphql/subscriptions/order-refunded.graphql @@ -0,0 +1,11 @@ +fragment OrderRefundedSubscriptionPayload on OrderRefunded { + order { + ...OrderBase + } +} + +subscription OrderRefunded { + event { + ...OrderRefundedSubscriptionPayload + } +} diff --git a/apps/orders-export/graphql/subscriptions/order-updated.graphql b/apps/orders-export/graphql/subscriptions/order-updated.graphql new file mode 100644 index 0000000..ff0540c --- /dev/null +++ b/apps/orders-export/graphql/subscriptions/order-updated.graphql @@ -0,0 +1,11 @@ +fragment OrderUpdatedSubscriptionPayload on OrderUpdated { + order { + ...OrderBase + } +} + +subscription OrderUpdated { + event { + ...OrderUpdatedSubscriptionPayload + } +} diff --git a/apps/orders-export/next-env.d.ts b/apps/orders-export/next-env.d.ts new file mode 100644 index 0000000..4f11a03 --- /dev/null +++ b/apps/orders-export/next-env.d.ts @@ -0,0 +1,5 @@ +/// +/// + +// NOTE: This file should not be edited +// see https://nextjs.org/docs/basic-features/typescript for more information. diff --git a/apps/orders-export/next.config.js b/apps/orders-export/next.config.js new file mode 100644 index 0000000..5d20c5b --- /dev/null +++ b/apps/orders-export/next.config.js @@ -0,0 +1,44 @@ +const { z } = require("zod"); +const { withSentryConfig } = require("@sentry/nextjs"); + +const RequiredEnvs = z.object({ + APL: z.string().min(1), +}); + +/** @type {import('next').NextConfig} */ +const nextConfig = () => { + try { + RequiredEnvs.parse(process.env); + } catch (e) { + console.error("🚫 Missing required env variables, see message below"); + console.error(e.issues); + process.exit(1); + } + + return { + reactStrictMode: true, + // TODO Infer names dynamically from disk + transpilePackages: ["@saleor/apps-shared", "@saleor/apps-ui", "@saleor/react-hook-form-macaw", "@saleor/trpc"], + }; +}; + +const isSentryPropertiesInEnvironment = + process.env.SENTRY_AUTH_TOKEN && process.env.SENTRY_PROJECT && process.env.SENTRY_ORG; + +const configWithSentry = withSentryConfig( + nextConfig, + { + silent: true, + org: process.env.SENTRY_ORG, + project: process.env.SENTRY_PROJECT, + }, + { + widenClientFileUpload: true, + transpileClientSDK: true, + tunnelRoute: "/monitoring", + hideSourceMaps: true, + disableLogger: true, + } +); + +module.exports = isSentryPropertiesInEnvironment ? configWithSentry : nextConfig; diff --git a/apps/orders-export/package.json b/apps/orders-export/package.json new file mode 100644 index 0000000..b11ef69 --- /dev/null +++ b/apps/orders-export/package.json @@ -0,0 +1,67 @@ +{ + "name": "saleor-app-orders-export", + "version": "0.0.0", + "scripts": { + "build": "pnpm generate && next build", + "dev": "pnpm generate && NODE_OPTIONS='--inspect' next dev", + "fetch-schema": "curl https://raw.githubusercontent.com/saleor/saleor/${npm_package_saleor_schemaVersion}/saleor/graphql/schema.graphql > graphql/schema.graphql", + "generate": "graphql-codegen", + "lint": "next lint", + "lint:fix": "eslint --fix .", + "start": "next start", + "test": "vitest" + }, + "dependencies": { + "@hookform/resolvers": "^3.1.0", + "@saleor/app-sdk": "0.43.1", + "@saleor/apps-shared": "workspace:*", + "@saleor/apps-ui": "workspace:*", + "@saleor/macaw-ui": "0.8.0-pre.127", + "@saleor/react-hook-form-macaw": "workspace:*", + "@saleor/trpc": "workspace:*", + "@sentry/nextjs": "7.67.0", + "@tanstack/react-query": "^4.29.19", + "@trpc/client": "10.38.1", + "@trpc/next": "10.38.1", + "@trpc/react-query": "10.38.1", + "@trpc/server": "10.38.1", + "@urql/exchange-auth": "^2.1.4", + "@vitejs/plugin-react": "4.0.4", + "graphql": "16.7.1", + "graphql-tag": "^2.12.6", + "jsdom": "^20.0.3", + "next": "13.4.8", + "pino": "^8.14.1", + "pino-pretty": "^10.0.0", + "react": "18.2.0", + "react-dom": "18.2.0", + "react-error-boundary": "4.0.10", + "react-hook-form": "^7.43.9", + "urql": "^4.0.4", + "usehooks-ts": "^2.9.1", + "vite": "4.4.8", + "vitest": "0.34.1", + "zod": "3.21.4" + }, + "devDependencies": { + "@graphql-codegen/cli": "4.0.1", + "@graphql-codegen/introspection": "4.0.0", + "@graphql-codegen/typed-document-node": "5.0.1", + "@graphql-codegen/typescript": "4.0.1", + "@graphql-codegen/typescript-operations": "4.0.1", + "@graphql-codegen/typescript-urql": "3.7.3", + "@graphql-typed-document-node/core": "3.2.0", + "@testing-library/react": "^14.0.0", + "@testing-library/react-hooks": "^8.0.1", + "@types/react": "18.2.5", + "@types/react-dom": "18.2.5", + "eslint": "8.46.0", + "eslint-config-saleor": "workspace:*", + "node-mocks-http": "^1.12.2", + "typescript": "5.1.6" + }, + "private": true, + "saleor": { + "schemaVersion": "3.14" + } +} diff --git a/apps/orders-export/sentry.client.config.ts b/apps/orders-export/sentry.client.config.ts new file mode 100644 index 0000000..6eef515 --- /dev/null +++ b/apps/orders-export/sentry.client.config.ts @@ -0,0 +1,37 @@ +/* + * This file configures the initialization of Sentry on the client. + * The config you add here will be used whenever a users loads a page in their browser. + * https://docs.sentry.io/platforms/javascript/guides/nextjs/ + */ + +import * as Sentry from "@sentry/nextjs"; +import pkg from "./package.json"; + +Sentry.init({ + dsn: process.env.NEXT_PUBLIC_SENTRY_DSN, + + // Adjust this value in production, or use tracesSampler for greater control + tracesSampleRate: 0.5, + + // Setting this option to true will print useful information to the console while you're setting up Sentry. + debug: false, + + replaysOnErrorSampleRate: 1.0, + + /* + * This sets the sample rate to be 10%. You may want this to be 100% while + * in development and sample at a lower rate in production + */ + replaysSessionSampleRate: 0.1, + + // You can remove this option if you're not planning to use the Sentry Session Replay feature: + integrations: [ + new Sentry.Replay({ + // Additional Replay configuration goes in here, for example: + maskAllText: true, + blockAllMedia: true, + }), + ], + environment: process.env.SENTRY_ENVIRONMENT, + release: `${pkg.name}@${pkg.version}`, +}); diff --git a/apps/orders-export/sentry.edge.config.ts b/apps/orders-export/sentry.edge.config.ts new file mode 100644 index 0000000..ca77fff --- /dev/null +++ b/apps/orders-export/sentry.edge.config.ts @@ -0,0 +1,21 @@ +/* + * This file configures the initialization of Sentry for edge features (middleware, edge routes, and so on). + * The config you add here will be used whenever one of the edge features is loaded. + * Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally. + * https://docs.sentry.io/platforms/javascript/guides/nextjs/ + */ + +import * as Sentry from "@sentry/nextjs"; +import pkg from "./package.json"; + +Sentry.init({ + dsn: process.env.NEXT_PUBLIC_SENTRY_DSN, + + // Adjust this value in production, or use tracesSampler for greater control + tracesSampleRate: 0.5, + + // Setting this option to true will print useful information to the console while you're setting up Sentry. + debug: false, + environment: process.env.SENTRY_ENVIRONMENT, + release: `${pkg.name}@${pkg.version}`, +}); diff --git a/apps/orders-export/sentry.server.config.ts b/apps/orders-export/sentry.server.config.ts new file mode 100644 index 0000000..fb1faea --- /dev/null +++ b/apps/orders-export/sentry.server.config.ts @@ -0,0 +1,20 @@ +/* + * This file configures the initialization of Sentry on the server. + * The config you add here will be used whenever the server handles a request. + * https://docs.sentry.io/platforms/javascript/guides/nextjs/ + */ + +import * as Sentry from "@sentry/nextjs"; +import pkg from "./package.json"; + +Sentry.init({ + dsn: process.env.NEXT_PUBLIC_SENTRY_DSN, + + // Adjust this value in production, or use tracesSampler for greater control + tracesSampleRate: 0.5, + + // Setting this option to true will print useful information to the console while you're setting up Sentry. + debug: false, + environment: process.env.SENTRY_ENVIRONMENT, + release: `${pkg.name}@${pkg.version}`, +}); diff --git a/apps/orders-export/src/modules/configuration/app-config-metadata-manager.ts b/apps/orders-export/src/modules/configuration/app-config-metadata-manager.ts new file mode 100644 index 0000000..e088bbc --- /dev/null +++ b/apps/orders-export/src/modules/configuration/app-config-metadata-manager.ts @@ -0,0 +1,36 @@ +import { SettingsManager } from "@saleor/app-sdk/settings-manager"; +import { AppConfig } from "./app-config"; +import { createSettingsManager } from "./metadata-manager"; +import { createGraphQLClient } from "@saleor/apps-shared"; +import { AuthData } from "@saleor/app-sdk/APL"; + +export class AppConfigMetadataManager { + public readonly metadataKey = "app-config-v1"; + + constructor(private mm: SettingsManager) {} + + async get() { + const metadata = await this.mm.get(this.metadataKey); + + return metadata ? AppConfig.parse(metadata) : new AppConfig(); + } + + set(config: AppConfig) { + return this.mm.set({ + key: this.metadataKey, + value: config.serialize(), + }); + } + + static createFromAuthData(authData: AuthData): AppConfigMetadataManager { + const settingsManager = createSettingsManager( + createGraphQLClient({ + saleorApiUrl: authData.saleorApiUrl, + token: authData.token, + }), + authData.appId, + ); + + return new AppConfigMetadataManager(settingsManager); + } +} diff --git a/apps/orders-export/src/modules/configuration/app-config.ts b/apps/orders-export/src/modules/configuration/app-config.ts new file mode 100644 index 0000000..cb51075 --- /dev/null +++ b/apps/orders-export/src/modules/configuration/app-config.ts @@ -0,0 +1,24 @@ +import { z } from "zod"; +import { RootConfig } from "./schemas/root-config.schema"; + +export class AppConfig { + private rootData: RootConfig.Shape = {}; + + constructor(initialData?: RootConfig.Shape) { + if (initialData) { + this.rootData = RootConfig.Schema.parse(initialData); + } + } + + static parse(serializedSchema: string) { + return new AppConfig(JSON.parse(serializedSchema)); + } + + serialize() { + return JSON.stringify(this.rootData); + } + + getConfig() { + return this.rootData; + } +} diff --git a/apps/orders-export/src/modules/configuration/configuration.router.ts b/apps/orders-export/src/modules/configuration/configuration.router.ts new file mode 100644 index 0000000..28f8b5b --- /dev/null +++ b/apps/orders-export/src/modules/configuration/configuration.router.ts @@ -0,0 +1,6 @@ +import { createLogger } from "@saleor/apps-shared"; +import { router } from "../trpc/trpc-server"; + +const logger = createLogger({ name: "configuration.router" }); + +export const configurationRouter = router({}); diff --git a/apps/orders-export/src/modules/configuration/metadata-manager.ts b/apps/orders-export/src/modules/configuration/metadata-manager.ts new file mode 100644 index 0000000..6877d9c --- /dev/null +++ b/apps/orders-export/src/modules/configuration/metadata-manager.ts @@ -0,0 +1,12 @@ +import { SettingsManager } from "@saleor/app-sdk/settings-manager"; +import { EncryptedMetadataManagerFactory } from "@saleor/apps-shared"; +import { Client } from "urql"; + +export const createSettingsManager = ( + client: Pick, + appId: string, +): SettingsManager => { + const metadataManagerFactory = new EncryptedMetadataManagerFactory(process.env.SECRET_KEY!); + + return metadataManagerFactory.create(client, appId); +}; diff --git a/apps/orders-export/src/modules/configuration/schemas/root-config.schema.ts b/apps/orders-export/src/modules/configuration/schemas/root-config.schema.ts new file mode 100644 index 0000000..1dca793 --- /dev/null +++ b/apps/orders-export/src/modules/configuration/schemas/root-config.schema.ts @@ -0,0 +1,12 @@ +import { z } from "zod"; + +export namespace RootConfig { + /** + * Store entire app config in single file + * - Only one request + * - Always transactional + */ + export const Schema = z.object({}); + + export type Shape = z.infer; +} diff --git a/apps/orders-export/src/modules/trpc/protected-client-procedure.ts b/apps/orders-export/src/modules/trpc/protected-client-procedure.ts new file mode 100644 index 0000000..1a9cc6e --- /dev/null +++ b/apps/orders-export/src/modules/trpc/protected-client-procedure.ts @@ -0,0 +1,117 @@ +import { verifyJWT } from "@saleor/app-sdk/verify-jwt"; +import { middleware, procedure } from "./trpc-server"; +import { TRPCError } from "@trpc/server"; +import { ProtectedHandlerError } from "@saleor/app-sdk/handlers/next"; +import { saleorApp } from "../../saleor-app"; +import { createGraphQLClient, logger } from "@saleor/apps-shared"; + +const attachAppToken = middleware(async ({ ctx, next }) => { + logger.debug("attachAppToken middleware"); + + if (!ctx.saleorApiUrl) { + logger.debug("ctx.saleorApiUrl not found, throwing"); + + throw new TRPCError({ + code: "BAD_REQUEST", + message: "Missing saleorApiUrl in request", + }); + } + + const authData = await saleorApp.apl.get(ctx.saleorApiUrl); + + if (!authData) { + logger.debug("authData not found, throwing 401"); + + throw new TRPCError({ + code: "UNAUTHORIZED", + message: "Missing auth data", + }); + } + + return next({ + ctx: { + appToken: authData.token, + saleorApiUrl: authData.saleorApiUrl, + appId: authData.appId, + }, + }); +}); + +const validateClientToken = middleware(async ({ ctx, next, meta }) => { + logger.debug( + { + permissions: meta?.requiredClientPermissions, + }, + "Calling validateClientToken middleware with permissions required", + ); + + if (!ctx.token) { + throw new TRPCError({ + code: "INTERNAL_SERVER_ERROR", + message: "Missing token in request. This middleware can be used only in frontend", + }); + } + + if (!ctx.appId) { + throw new TRPCError({ + code: "INTERNAL_SERVER_ERROR", + message: "Missing appId in request. This middleware can be used after auth is attached", + }); + } + + if (!ctx.saleorApiUrl) { + throw new TRPCError({ + code: "INTERNAL_SERVER_ERROR", + message: + "Missing saleorApiUrl in request. This middleware can be used after auth is attached", + }); + } + + if (!ctx.ssr) { + try { + logger.debug("trying to verify JWT token from frontend"); + logger.debug({ token: ctx.token ? `${ctx.token[0]}...` : undefined }); + + await verifyJWT({ + appId: ctx.appId, + token: ctx.token, + saleorApiUrl: ctx.saleorApiUrl, + requiredPermissions: meta?.requiredClientPermissions ?? [], + }); + } catch (e) { + logger.debug("JWT verification failed, throwing"); + throw new ProtectedHandlerError("JWT verification failed: ", "JWT_VERIFICATION_FAILED"); + } + } + + return next({ + ctx: { + ...ctx, + saleorApiUrl: ctx.saleorApiUrl, + }, + }); +}); + +/** + * Construct common graphQL client and attach it to the context + * + * Can be used only if called from the frontend (react-query), + * otherwise jwks validation will fail (if createCaller used) + * + * TODO Rethink middleware composition to enable safe server-side router calls + */ +export const protectedClientProcedure = procedure + .use(attachAppToken) + .use(validateClientToken) + .use(async ({ ctx, next }) => { + const client = createGraphQLClient({ saleorApiUrl: ctx.saleorApiUrl, token: ctx.appToken }); + + return next({ + ctx: { + apiClient: client, + appToken: ctx.appToken, + saleorApiUrl: ctx.saleorApiUrl, + appId: ctx.appId!, + }, + }); + }); diff --git a/apps/orders-export/src/modules/trpc/trpc-app-router.ts b/apps/orders-export/src/modules/trpc/trpc-app-router.ts new file mode 100644 index 0000000..5093eed --- /dev/null +++ b/apps/orders-export/src/modules/trpc/trpc-app-router.ts @@ -0,0 +1,8 @@ +import { configurationRouter } from "../configuration/configuration.router"; +import { router } from "./trpc-server"; + +export const appRouter = router({ + configuration: configurationRouter, +}); + +export type AppRouter = typeof appRouter; diff --git a/apps/orders-export/src/modules/trpc/trpc-client.ts b/apps/orders-export/src/modules/trpc/trpc-client.ts new file mode 100644 index 0000000..22fff73 --- /dev/null +++ b/apps/orders-export/src/modules/trpc/trpc-client.ts @@ -0,0 +1,15 @@ +import { createTRPCNext } from "@trpc/next"; + +import { createHttpBatchLink } from "@saleor/trpc"; +import { appBridgeInstance } from "../../pages/_app"; +import { AppRouter } from "./trpc-app-router"; + +export const trpcClient = createTRPCNext({ + config() { + return { + links: [createHttpBatchLink(appBridgeInstance)], + queryClientConfig: { defaultOptions: { queries: { refetchOnWindowFocus: false } } }, + }; + }, + ssr: false, +}); diff --git a/apps/orders-export/src/modules/trpc/trpc-server.ts b/apps/orders-export/src/modules/trpc/trpc-server.ts new file mode 100644 index 0000000..9109e3b --- /dev/null +++ b/apps/orders-export/src/modules/trpc/trpc-server.ts @@ -0,0 +1,31 @@ +import { initTRPC } from "@trpc/server"; +import { TrpcContext } from "@saleor/trpc"; +import { Permission } from "@saleor/app-sdk/types"; +import { ZodError } from "zod"; + +interface Meta { + requiredClientPermissions?: Permission[]; + updateWebhooks?: boolean; +} + +const t = initTRPC + .context() + .meta() + .create({ + errorFormatter({ shape, error }) { + return { + ...shape, + data: { + ...shape.data, + zodError: + error.code === "BAD_REQUEST" && error.cause instanceof ZodError + ? error.cause.flatten() + : null, + }, + }; + }, + }); + +export const router = t.router; +export const procedure = t.procedure; +export const middleware = t.middleware; diff --git a/apps/segment/src/modules/ui/app-header.tsx b/apps/orders-export/src/modules/ui/app-header.tsx similarity index 100% rename from apps/segment/src/modules/ui/app-header.tsx rename to apps/orders-export/src/modules/ui/app-header.tsx diff --git a/apps/orders-export/src/pages/_app.tsx b/apps/orders-export/src/pages/_app.tsx new file mode 100644 index 0000000..798623c --- /dev/null +++ b/apps/orders-export/src/pages/_app.tsx @@ -0,0 +1,45 @@ +import "@saleor/macaw-ui/next/style"; +import { trpcClient } from "@/modules/trpc/trpc-client"; +import { AppBridge, AppBridgeProvider } from "@saleor/app-sdk/app-bridge"; +import { RoutePropagator } from "@saleor/app-sdk/app-bridge/next"; +import { GraphQLProvider, NoSSRWrapper, ThemeSynchronizer } from "@saleor/apps-shared"; +import { Box, ThemeProvider } from "@saleor/macaw-ui/next"; + +import { QueryClient, QueryClientProvider } from "@tanstack/react-query"; +import { AppProps } from "next/app"; + +/** + * Ensure instance is a singleton. + * TODO: This is React 18 issue, consider hiding this workaround inside app-sdk + */ +export const appBridgeInstance = typeof window !== "undefined" ? new AppBridge() : undefined; + +const queryClient = new QueryClient({ + defaultOptions: { + queries: { + refetchOnWindowFocus: false, + }, + }, +}); + +function NextApp({ Component, pageProps }: AppProps) { + return ( + + + + + + + + + + + + + + + + ); +} + +export default trpcClient.withTRPC(NextApp); diff --git a/apps/orders-export/src/pages/_document.tsx b/apps/orders-export/src/pages/_document.tsx new file mode 100644 index 0000000..b2fff8b --- /dev/null +++ b/apps/orders-export/src/pages/_document.tsx @@ -0,0 +1,13 @@ +import { Html, Head, Main, NextScript } from "next/document"; + +export default function Document() { + return ( + + + +
+ + + + ); +} diff --git a/apps/orders-export/src/pages/api/manifest.ts b/apps/orders-export/src/pages/api/manifest.ts new file mode 100644 index 0000000..4c9f121 --- /dev/null +++ b/apps/orders-export/src/pages/api/manifest.ts @@ -0,0 +1,45 @@ +import { createManifestHandler } from "@saleor/app-sdk/handlers/next"; +import { AppManifest } from "@saleor/app-sdk/types"; + +import packageJson from "../../../package.json"; + +export default createManifestHandler({ + async manifestFactory({ appBaseUrl }) { + const iframeBaseUrl = process.env.APP_IFRAME_BASE_URL ?? appBaseUrl; + const apiBaseURL = process.env.APP_API_BASE_URL ?? appBaseUrl; + + const manifest: AppManifest = { + about: "Export Saleor orders to spreadsheets", + appUrl: iframeBaseUrl, + author: "Saleor Commerce", + /* + * brand: { + * logo: { + * default: `${apiBaseURL}/logo.png`, + * }, + * }, + */ + dataPrivacyUrl: "https://saleor.io/legal/privacy/", + extensions: [ + /** + * Optionally, extend Dashboard with custom UIs + * https://docs.saleor.io/docs/3.x/developer/extending/apps/extending-dashboard-with-apps + */ + ], + homepageUrl: "https://github.com/saleor/apps", + id: "saleor.app.orders-export", + name: "Orders Export", + permissions: ["MANAGE_ORDERS"], + requiredSaleorVersion: ">=3.14 <4", + supportUrl: "https://github.com/saleor/apps/discussions", + tokenTargetUrl: `${apiBaseURL}/api/register`, + version: packageJson.version, + /* + * TODO Add webhooks disabled and enable then when configured + */ + webhooks: [], + }; + + return manifest; + }, +}); diff --git a/apps/orders-export/src/pages/api/register.ts b/apps/orders-export/src/pages/api/register.ts new file mode 100644 index 0000000..ec1b0df --- /dev/null +++ b/apps/orders-export/src/pages/api/register.ts @@ -0,0 +1,23 @@ +import { saleorApp } from "@/saleor-app"; +import { createAppRegisterHandler } from "@saleor/app-sdk/handlers/next"; + +const allowedUrlsPattern = process.env.ALLOWED_DOMAIN_PATTERN; + +/** + * Required endpoint, called by Saleor to install app. + * It will exchange tokens with app, so saleorApp.apl will contain token + */ +export default createAppRegisterHandler({ + apl: saleorApp.apl, + allowedSaleorUrls: [ + (url) => { + if (allowedUrlsPattern) { + const regex = new RegExp(allowedUrlsPattern); + + return regex.test(url); + } + + return true; + }, + ], +}); diff --git a/apps/orders-export/src/pages/api/trpc/[trpc].ts b/apps/orders-export/src/pages/api/trpc/[trpc].ts new file mode 100644 index 0000000..7b764a2 --- /dev/null +++ b/apps/orders-export/src/pages/api/trpc/[trpc].ts @@ -0,0 +1,9 @@ +import * as trpcNext from "@trpc/server/adapters/next"; + +import { appRouter } from "../../../modules/trpc/trpc-app-router"; +import { createTrpcContext } from "@saleor/trpc"; + +export default trpcNext.createNextApiHandler({ + router: appRouter, + createContext: createTrpcContext, +}); diff --git a/apps/orders-export/src/pages/configuration.tsx b/apps/orders-export/src/pages/configuration.tsx new file mode 100644 index 0000000..4485a86 --- /dev/null +++ b/apps/orders-export/src/pages/configuration.tsx @@ -0,0 +1,28 @@ +import { AppHeader } from "@/modules/ui/app-header"; +import { useAppBridge } from "@saleor/app-sdk/app-bridge"; +import { Layout } from "@saleor/apps-ui"; +import { Box, Text } from "@saleor/macaw-ui/next"; +import { NextPage } from "next"; + +const ConfigurationPage: NextPage = () => { + const { appBridgeState } = useAppBridge(); + + if (!appBridgeState) { + return null; + } + + if (appBridgeState.user?.permissions.includes("MANAGE_APPS") === false) { + return You do not have permission to access this page.; + } + + return ( + + + + todo + + + ); +}; + +export default ConfigurationPage; diff --git a/apps/orders-export/src/pages/index.tsx b/apps/orders-export/src/pages/index.tsx new file mode 100644 index 0000000..554f156 --- /dev/null +++ b/apps/orders-export/src/pages/index.tsx @@ -0,0 +1,30 @@ +import { NextPage } from "next"; +import { useAppBridge } from "@saleor/app-sdk/app-bridge"; +import { useEffect } from "react"; +import { useIsMounted } from "usehooks-ts"; +import { useRouter } from "next/router"; +import { isInIframe } from "@saleor/apps-shared"; + +const IndexPage: NextPage = () => { + const { appBridgeState } = useAppBridge(); + const isMounted = useIsMounted(); + const { replace } = useRouter(); + + useEffect(() => { + if (isMounted() && appBridgeState?.ready) { + replace("/configuration"); + } + }, [isMounted, appBridgeState?.ready, replace]); + + if (isInIframe()) { + return

Loading

; + } + + return ( +
+

Saleor App - Orders Export

+
+ ); +}; + +export default IndexPage; diff --git a/apps/orders-export/src/saleor-app.ts b/apps/orders-export/src/saleor-app.ts new file mode 100644 index 0000000..67fb20d --- /dev/null +++ b/apps/orders-export/src/saleor-app.ts @@ -0,0 +1,35 @@ +import { APL, FileAPL, SaleorCloudAPL, UpstashAPL } from "@saleor/app-sdk/APL"; +import { SaleorApp } from "@saleor/app-sdk/saleor-app"; + +const aplType = process.env.APL ?? "file"; + +export let apl: APL; + +switch (aplType) { + case "upstash": + apl = new UpstashAPL(); + + break; + case "file": + apl = new FileAPL(); + + break; + case "saleor-cloud": { + if (!process.env.REST_APL_ENDPOINT || !process.env.REST_APL_TOKEN) { + throw new Error("Rest APL is not configured - missing env variables. Check saleor-app.ts"); + } + + apl = new SaleorCloudAPL({ + resourceUrl: process.env.REST_APL_ENDPOINT, + token: process.env.REST_APL_TOKEN, + }); + + break; + } + default: { + throw new Error("Invalid APL config, "); + } +} +export const saleorApp = new SaleorApp({ + apl, +}); diff --git a/apps/orders-export/src/setup-tests.ts b/apps/orders-export/src/setup-tests.ts new file mode 100644 index 0000000..cb0ff5c --- /dev/null +++ b/apps/orders-export/src/setup-tests.ts @@ -0,0 +1 @@ +export {}; diff --git a/apps/orders-export/tsconfig.json b/apps/orders-export/tsconfig.json new file mode 100644 index 0000000..61c19ab --- /dev/null +++ b/apps/orders-export/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "target": "es5", + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "noEmit": true, + "esModuleInterop": true, + "module": "esnext", + "moduleResolution": "node", + "resolveJsonModule": true, + "isolatedModules": true, + "jsx": "preserve", + "incremental": true, + "paths": { + "@/*": ["./src/*"] + } + }, + "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"], + "exclude": ["node_modules"] +} diff --git a/apps/orders-export/turbo.json b/apps/orders-export/turbo.json new file mode 100644 index 0000000..c08adae --- /dev/null +++ b/apps/orders-export/turbo.json @@ -0,0 +1,28 @@ +{ + "extends": ["//"], + "$schema": "https://turbo.build/schema.json", + "pipeline": { + "build": { + "env": [ + "APL", + "APP_DEBUG", + "NODE_ENV", + "SECRET_KEY", + "ALLOWED_DOMAIN_PATTERN", + "REST_APL_ENDPOINT", + "REST_APL_TOKEN", + "NEXT_PUBLIC_VERCEL_ENV", + "VERCEL_URL", + "PORT", + "SENTRY_ORG", + "SENTRY_PROJECT", + "SENTRY_DSN", + "SENTRY_AUTH_TOKEN", + "NEXT_PUBLIC_SENTRY_DSN", + "SENTRY_ENVIRONMENT", + "APP_IFRAME_BASE_URL", + "APP_API_BASE_URL" + ] + } + } +} diff --git a/apps/orders-export/vitest.config.ts b/apps/orders-export/vitest.config.ts new file mode 100644 index 0000000..2f87470 --- /dev/null +++ b/apps/orders-export/vitest.config.ts @@ -0,0 +1,17 @@ +import react from "@vitejs/plugin-react"; + +import { defineConfig } from "vitest/config"; + +// https://vitejs.dev/config/ +export default defineConfig({ + plugins: [react()], + test: { + passWithNoTests: true, + environment: "jsdom", + setupFiles: "./src/setup-tests.ts", + css: false, + alias: { + "@": "./src", + }, + }, +}); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 781c002..8131bea 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1,5 +1,9 @@ lockfileVersion: '6.0' +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + overrides: '@saleor/app-sdk': 0.43.1 @@ -896,6 +900,145 @@ importers: specifier: 5.1.6 version: 5.1.6 + apps/orders-export: + dependencies: + '@hookform/resolvers': + specifier: ^3.1.0 + version: 3.1.0(react-hook-form@7.44.3) + '@saleor/app-sdk': + specifier: 0.43.1 + version: 0.43.1(graphql@16.7.1)(next@13.4.8)(react-dom@18.2.0)(react@18.2.0) + '@saleor/apps-shared': + specifier: workspace:* + version: link:../../packages/shared + '@saleor/apps-ui': + specifier: workspace:* + version: link:../../packages/ui + '@saleor/macaw-ui': + specifier: 0.8.0-pre.127 + version: 0.8.0-pre.127(@types/react-dom@18.2.5)(@types/react@18.2.5)(react-dom@18.2.0)(react@18.2.0) + '@saleor/react-hook-form-macaw': + specifier: workspace:* + version: link:../../packages/react-hook-form-macaw + '@saleor/trpc': + specifier: workspace:* + version: link:../../packages/trpc + '@sentry/nextjs': + specifier: 7.67.0 + version: 7.67.0(next@13.4.8)(react@18.2.0) + '@tanstack/react-query': + specifier: ^4.29.19 + version: 4.29.19(react-dom@18.2.0)(react@18.2.0) + '@trpc/client': + specifier: 10.38.1 + version: 10.38.1(@trpc/server@10.38.1) + '@trpc/next': + specifier: 10.38.1 + version: 10.38.1(@tanstack/react-query@4.29.19)(@trpc/client@10.38.1)(@trpc/react-query@10.38.1)(@trpc/server@10.38.1)(next@13.4.8)(react-dom@18.2.0)(react@18.2.0) + '@trpc/react-query': + specifier: 10.38.1 + version: 10.38.1(@tanstack/react-query@4.29.19)(@trpc/client@10.38.1)(@trpc/server@10.38.1)(react-dom@18.2.0)(react@18.2.0) + '@trpc/server': + specifier: 10.38.1 + version: 10.38.1 + '@urql/exchange-auth': + specifier: ^2.1.4 + version: 2.1.4(graphql@16.7.1) + '@vitejs/plugin-react': + specifier: 4.0.4 + version: 4.0.4(vite@4.4.8) + graphql: + specifier: 16.7.1 + version: 16.7.1 + graphql-tag: + specifier: ^2.12.6 + version: 2.12.6(graphql@16.7.1) + jsdom: + specifier: ^20.0.3 + version: 20.0.3 + next: + specifier: 13.4.8 + version: 13.4.8(@babel/core@7.22.11)(react-dom@18.2.0)(react@18.2.0) + pino: + specifier: ^8.14.1 + version: 8.14.1 + pino-pretty: + specifier: ^10.0.0 + version: 10.0.0 + react: + specifier: 18.2.0 + version: 18.2.0 + react-dom: + specifier: 18.2.0 + version: 18.2.0(react@18.2.0) + react-error-boundary: + specifier: 4.0.10 + version: 4.0.10(react@18.2.0) + react-hook-form: + specifier: ^7.43.9 + version: 7.44.3(react@18.2.0) + urql: + specifier: ^4.0.4 + version: 4.0.4(graphql@16.7.1)(react@18.2.0) + usehooks-ts: + specifier: ^2.9.1 + version: 2.9.1(react-dom@18.2.0)(react@18.2.0) + vite: + specifier: 4.4.8 + version: 4.4.8(@types/node@18.15.3) + vitest: + specifier: 0.34.1 + version: 0.34.1(jsdom@20.0.3) + zod: + specifier: 3.21.4 + version: 3.21.4 + devDependencies: + '@graphql-codegen/cli': + specifier: 4.0.1 + version: 4.0.1(@babel/core@7.22.11)(@types/node@18.15.3)(graphql@16.7.1) + '@graphql-codegen/introspection': + specifier: 4.0.0 + version: 4.0.0(graphql@16.7.1) + '@graphql-codegen/typed-document-node': + specifier: 5.0.1 + version: 5.0.1(graphql@16.7.1) + '@graphql-codegen/typescript': + specifier: 4.0.1 + version: 4.0.1(graphql@16.7.1) + '@graphql-codegen/typescript-operations': + specifier: 4.0.1 + version: 4.0.1(graphql@16.7.1) + '@graphql-codegen/typescript-urql': + specifier: 3.7.3 + version: 3.7.3(graphql-tag@2.12.6)(graphql@16.7.1) + '@graphql-typed-document-node/core': + specifier: 3.2.0 + version: 3.2.0(graphql@16.7.1) + '@testing-library/react': + specifier: ^14.0.0 + version: 14.0.0(react-dom@18.2.0)(react@18.2.0) + '@testing-library/react-hooks': + specifier: ^8.0.1 + version: 8.0.1(@types/react@18.2.5)(react-dom@18.2.0)(react@18.2.0) + '@types/react': + specifier: 18.2.5 + version: 18.2.5 + '@types/react-dom': + specifier: 18.2.5 + version: 18.2.5 + eslint: + specifier: 8.46.0 + version: 8.46.0 + eslint-config-saleor: + specifier: workspace:* + version: link:../../packages/eslint-config-saleor + node-mocks-http: + specifier: ^1.12.2 + version: 1.12.2 + typescript: + specifier: 5.1.6 + version: 5.1.6 + apps/products-feed: dependencies: '@aws-sdk/client-s3': @@ -5782,6 +5925,7 @@ packages: engines: {node: '>=6.9.0'} dependencies: regenerator-runtime: 0.13.11 + dev: true /@babel/template@7.22.5: resolution: {integrity: sha512-X7yV7eiwAxdj9k94NEylvbVHLiVG1nvzCV2EAowhxLTwODV1jl9UzZ48leOC0sH7OnuHrIkllaBgneUykIcZaw==} @@ -12876,6 +13020,7 @@ packages: /chevrotain@6.5.0: resolution: {integrity: sha512-BwqQ/AgmKJ8jcMEjaSnfMybnKMgGTrtDKowfTP3pX4jwVy0kNjRsT/AP6h+wC3+3NC+X8X15VWBnTCQlX+wQFg==} + requiresBuild: true dependencies: regexp-to-ast: 0.4.0 dev: false @@ -15738,7 +15883,7 @@ packages: graphql: ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 dependencies: graphql: 16.7.1 - tslib: 2.6.1 + tslib: 2.6.2 /graphql-ws@5.14.0(graphql@16.7.1): resolution: {integrity: sha512-itrUTQZP/TgswR4GSSYuwWUzrE/w5GhbwM2GX3ic2U7aw33jgEsayfIlvaj7/GcIvZgNMzsPTrE5hqPuFUiE5g==} @@ -19455,7 +19600,7 @@ packages: peerDependencies: react: '>=16.13.1' dependencies: - '@babel/runtime': 7.22.6 + '@babel/runtime': 7.22.11 react: 18.2.0 dev: false @@ -19948,6 +20093,7 @@ packages: /regexp-to-ast@0.4.0: resolution: {integrity: sha512-4qf/7IsIKfSNHQXSwial1IFmfM1Cc/whNBQqRwe0V2stPe7KmN1U0tWQiIx6JiirgSrisjE0eECdNf7Tav1Ntw==} + requiresBuild: true dev: false optional: true @@ -21181,6 +21327,7 @@ packages: /tiny-emitter@2.1.0: resolution: {integrity: sha512-NB6Dk1A9xgQPMoGqC5CVXn123gWyte215ONT5Pp5a0yt4nlEoO1ZWeCwpncaekPHXO60i47ihFnZPiRPjRMq4Q==} + requiresBuild: true dev: false optional: true @@ -21342,6 +21489,7 @@ packages: /tslib@2.6.1: resolution: {integrity: sha512-t0hLfiEKfMUoqhG+U1oid7Pva4bbDPHYfJNiB7BiIjRkj1pyC++4N3huJfqY6aRH6VTB0rvtzQwjM4K6qpfOig==} + dev: false /tslib@2.6.2: resolution: {integrity: sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==} @@ -21697,6 +21845,7 @@ packages: /unorm@1.6.0: resolution: {integrity: sha512-b2/KCUlYZUeA7JFUuRJZPUtr4gZvBh7tavtv4fvk4+KV9pfGiR6CQAQAWl49ZpR3ts2dk4FYkP7EIgDJoiOLDA==} engines: {node: '>= 0.4.0'} + requiresBuild: true dev: false optional: true @@ -22615,7 +22764,3 @@ packages: /zod@3.21.4: resolution: {integrity: sha512-m46AKbrzKVzOzs/DZgVnG5H55N1sv1M8qZU3A8RIKbs3mrACDNeIOeilDymVb2HdmP8uwshOCF4uJ8uM9rCqJw==} - -settings: - autoInstallPeers: true - excludeLinksFromLockfile: false