diff --git a/schema-main.graphql b/schema-main.graphql
index e82ef38ddfb..a7c1894a06c 100644
--- a/schema-main.graphql
+++ b/schema-main.graphql
@@ -1,9 +1,3 @@
-schema {
- query: Query
- mutation: Mutation
- subscription: Subscription
-}
-
"""Groups fields and operations into named groups."""
directive @doc(
"""Name of the grouping category"""
@@ -26,14 +20,14 @@ type Query {
webhook(
"""ID of the webhook."""
id: ID!
- ): Webhook @doc(category: "Webhooks")
+ ): Webhook
"""
List of all available webhook events.
Requires one of the following permissions: MANAGE_APPS.
"""
- webhookEvents: [WebhookEvent!] @doc(category: "Webhooks") @deprecated(reason: "Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types.")
+ webhookEvents: [WebhookEvent!] @deprecated(reason: "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.
@@ -41,7 +35,7 @@ type Query {
webhookSamplePayload(
"""Name of the requested event type."""
eventType: WebhookSampleEventTypeEnum!
- ): JSONString @doc(category: "Webhooks")
+ ): JSONString
"""
Look up a warehouse by ID.
@@ -54,7 +48,7 @@ type Query {
"""External ID of a warehouse."""
externalReference: String
- ): Warehouse @doc(category: "Products")
+ ): Warehouse
"""
List of warehouses.
@@ -80,7 +74,7 @@ type Query {
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")
+ ): WarehouseCountableConnection
"""
Returns a list of all translatable items of a given kind.
@@ -129,7 +123,7 @@ type Query {
taxConfiguration(
"""ID of a tax configuration."""
id: ID!
- ): TaxConfiguration @doc(category: "Taxes")
+ ): TaxConfiguration
"""
List of tax configurations.
@@ -155,7 +149,7 @@ type Query {
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")
+ ): TaxConfigurationCountableConnection
"""
Look up a tax class.
@@ -165,7 +159,7 @@ type Query {
taxClass(
"""ID of a tax class."""
id: ID!
- ): TaxClass @doc(category: "Taxes")
+ ): TaxClass
"""
List of tax classes.
@@ -194,7 +188,7 @@ type Query {
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")
+ ): TaxClassCountableConnection
"""
Tax class rates grouped by country.
@@ -204,10 +198,10 @@ type Query {
taxCountryConfiguration(
"""Country for which to return tax class rates."""
countryCode: CountryCode!
- ): TaxCountryConfiguration @doc(category: "Taxes")
+ ): TaxCountryConfiguration
- "\\n\\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP."
- taxCountryConfigurations: [TaxCountryConfiguration!] @doc(category: "Taxes")
+ "\n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP."
+ taxCountryConfigurations: [TaxCountryConfiguration!]
"""
Look up a stock by ID
@@ -217,7 +211,7 @@ type Query {
stock(
"""ID of a stock"""
id: ID!
- ): Stock @doc(category: "Products")
+ ): Stock
"""
List of stocks.
@@ -242,7 +236,7 @@ type Query {
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")
+ ): StockCountableConnection
"""Return information about the shop."""
shop: Shop!
@@ -252,19 +246,24 @@ type Query {
Requires one of the following permissions: MANAGE_ORDERS.
"""
- orderSettings: OrderSettings @doc(category: "Orders") @deprecated(reason: "Use the `channel` query to fetch the `orderSettings` field instead.")
+ orderSettings: OrderSettings @deprecated(reason: "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")
+ giftCardSettings: GiftCardSettings!
"""
Refunds related settings. Returns `RefundSettings` configuration, global for the entire shop.
"""
- refundSettings: RefundSettings! @doc(category: "Shop")
+ refundSettings: RefundSettings!
+
+ """
+ Returns related settings. Returns `ReturnSettings` configuration, global for the entire shop.
+ """
+ returnSettings: ReturnSettings!
"""
Look up a shipping zone by ID.
@@ -277,7 +276,7 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): ShippingZone @doc(category: "Shipping")
+ ): ShippingZone
"""
List of the shop's shipping zones.
@@ -306,7 +305,7 @@ type Query {
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")
+ ): ShippingZoneCountableConnection
"""
Look up digital content by ID.
@@ -316,7 +315,7 @@ type Query {
digitalContent(
"""ID of the digital content."""
id: ID!
- ): DigitalContent @doc(category: "Products")
+ ): DigitalContent @deprecated(reason: "Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.")
"""
List of digital content.
@@ -339,7 +338,7 @@ type Query {
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")
+ ): DigitalContentCountableConnection @deprecated(reason: "Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.")
"""List of the shop's categories."""
categories(
@@ -370,7 +369,7 @@ type Query {
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")
+ ): CategoryCountableConnection
"""Look up a category by ID or slug."""
category(
@@ -386,7 +385,7 @@ type Query {
Added in Saleor 3.21.
"""
slugLanguageCode: LanguageCodeEnum
- ): Category @doc(category: "Products")
+ ): Category
"""
Look up a collection by ID or slug. If slugLanguageCode is provided, category will be fetched by slug translation. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
@@ -407,7 +406,7 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): Collection @doc(category: "Products")
+ ): Collection
"""
List of the shop's collections. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
@@ -440,7 +439,7 @@ type Query {
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")
+ ): CollectionCountableConnection
"""
Look up a product by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
@@ -464,14 +463,18 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): Product @doc(category: "Products")
+ ): Product
"""
List of the shop's products. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
products(
- """Filtering options for products."""
- filter: ProductFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """
+ Filtering options for products.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: ProductFilterInput
"""Where filtering options for products."""
where: ProductWhereInput
@@ -500,13 +503,13 @@ type Query {
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")
+ ): ProductCountableConnection
"""Look up a product type by ID."""
productType(
"""ID of the product type."""
id: ID!
- ): ProductType @doc(category: "Products")
+ ): ProductType
"""List of the shop's product types."""
productTypes(
@@ -531,7 +534,7 @@ type Query {
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")
+ ): ProductTypeCountableConnection
"""
Look up a product variant by ID or SKU. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
@@ -548,7 +551,7 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): ProductVariant @doc(category: "Products")
+ ): ProductVariant
"""
List of product variants. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
@@ -560,8 +563,12 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- """Filtering options for product variants."""
- filter: ProductVariantFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """
+ Filtering options for product variants.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: ProductVariantFilterInput
"""Where filtering options for product variants."""
where: ProductVariantWhereInput
@@ -591,7 +598,7 @@ type Query {
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")
+ ): ProductVariantCountableConnection
"""
List of top selling products.
@@ -620,7 +627,7 @@ type Query {
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") @deprecated
+ ): ProductVariantCountableConnection @deprecated
"""
Look up a payment by ID.
@@ -630,7 +637,7 @@ type Query {
payment(
"""ID of the payment."""
id: ID!
- ): Payment @doc(category: "Payments")
+ ): Payment
"""
List of payments.
@@ -656,12 +663,12 @@ type Query {
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")
+ ): PaymentCountableConnection
"""
Look up a transaction by ID.
- Requires one of the following permissions: HANDLE_PAYMENTS.
+ Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
"""
transaction(
"""
@@ -673,7 +680,35 @@ type Query {
Token of a transaction. Either it or ID is required to fetch the transaction data.
"""
token: UUID
- ): TransactionItem @doc(category: "Payments")
+ ): TransactionItem
+
+ """
+ List of transactions. For apps with `MANAGE_ORDERS` permission, returns all transactions. For apps with just `HANDLE_PAYMENTS` permission, returns only transactions created by that app. For staff users, returns transactions from orders and checkouts in channels they have access to.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
+ """
+ transactions(
+ """Where filtering options for transactions."""
+ where: TransactionWhereInput
+
+ """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
+ ): TransactionCountableConnection
"""Look up a page by ID or slug."""
page(
@@ -696,15 +731,19 @@ type Query {
Added in Saleor 3.22.
"""
channel: String
- ): Page @doc(category: "Pages")
+ ): Page
"""List of the shop's pages."""
pages(
"""Sort pages."""
sortBy: PageSortingInput
- """Filtering options for pages."""
- filter: PageFilterInput @deprecated(reason: "+ Use `where` and `search` instead.")
+ """
+ Filtering options for pages.
+
+ DEPRECATED: this field will be removed. + Use `where` and `search` instead.
+ """
+ filter: PageFilterInput
"""
Search pages. Overrides filter.search input.
@@ -742,13 +781,13 @@ type Query {
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")
+ ): PageCountableConnection
"""Look up a page type by ID."""
pageType(
"""ID of the page type."""
id: ID!
- ): PageType @doc(category: "Pages")
+ ): PageType
"""List of the page types."""
pageTypes(
@@ -773,7 +812,7 @@ type Query {
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")
+ ): PageTypeCountableConnection
"""
List of activity events to display on homepage (at the moment it only contains order-events).
@@ -796,7 +835,7 @@ type Query {
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") @deprecated
+ ): OrderEventCountableConnection @deprecated
"""Look up an order by ID or external reference."""
order(
@@ -809,7 +848,7 @@ type Query {
Requires one of the following permissions: MANAGE_ORDERS.
"""
externalReference: String
- ): Order @doc(category: "Orders")
+ ): Order
"""
List of orders. The query will not initiate any external requests, including filtering available shipping methods, or performing external tax calculations.
@@ -820,8 +859,12 @@ type Query {
"""Sort orders."""
sortBy: OrderSortingInput
- """Filtering options for orders."""
- filter: OrderFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """
+ Filtering options for orders.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: OrderFilterInput
"""
Where filtering options for orders.
@@ -855,7 +898,7 @@ type Query {
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")
+ ): OrderCountableConnection
"""
List of draft orders. The query will not initiate any external requests, including filtering available shipping methods, or performing external tax calculations.
@@ -866,8 +909,12 @@ type Query {
"""Sort draft orders."""
sortBy: OrderSortingInput
- """Filtering options for draft orders."""
- filter: OrderDraftFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """
+ Filtering options for draft orders.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: OrderDraftFilterInput
"""
Where filtering options for draft orders.
@@ -898,7 +945,7 @@ type Query {
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")
+ ): OrderCountableConnection
"""
Return the total sales amount from a specific period.
@@ -911,13 +958,13 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): TaxedMoney @doc(category: "Orders") @deprecated
+ ): TaxedMoney @deprecated
"""Look up an order by token."""
orderByToken(
"""The order's token."""
token: UUID!
- ): Order @doc(category: "Orders") @deprecated
+ ): Order @deprecated
"""Look up a navigation menu by ID or name."""
menu(
@@ -932,7 +979,7 @@ type Query {
"""The menu's slug."""
slug: String
- ): Menu @doc(category: "Menu")
+ ): Menu
"""List of the storefront's menus."""
menus(
@@ -964,7 +1011,7 @@ type Query {
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")
+ ): MenuCountableConnection
"""Look up a menu item by ID."""
menuItem(
@@ -973,7 +1020,7 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): MenuItem @doc(category: "Menu")
+ ): MenuItem
"""List of the storefronts's menu items."""
menuItems(
@@ -1001,7 +1048,7 @@ type Query {
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")
+ ): MenuItemCountableConnection
"""
Look up a gift card by ID.
@@ -1011,7 +1058,7 @@ type Query {
giftCard(
"""ID of the gift card."""
id: ID!
- ): GiftCard @doc(category: "Gift cards")
+ ): GiftCard
"""
List of gift cards.
@@ -1045,14 +1092,14 @@ type Query {
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")
+ ): GiftCardCountableConnection
"""
List of gift card currencies.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
- giftCardCurrencies: [String!]! @doc(category: "Gift cards")
+ giftCardCurrencies: [String!]!
"""
List of gift card tags.
@@ -1078,7 +1125,7 @@ type Query {
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")
+ ): GiftCardTagCountableConnection
"""
Look up a plugin by ID.
@@ -1130,7 +1177,7 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): Sale @doc(category: "Discounts") @deprecated(reason: "Use the `promotion` query instead.")
+ ): Sale @deprecated(reason: "Use the `promotion` query instead.")
"""
List of the shop's sales.
@@ -1144,8 +1191,12 @@ type Query {
"""Sort sales."""
sortBy: SaleSortingInput
- """Search sales by name, value or type."""
- query: String @deprecated(reason: "Use `filter.search` input instead.")
+ """
+ Search sales by name, value or type.
+
+ DEPRECATED: this field will be removed. Use `filter.search` input instead.
+ """
+ query: String
"""Slug of a channel for which the data should be returned."""
channel: String
@@ -1165,7 +1216,7 @@ type Query {
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") @deprecated(reason: "Use the `promotions` query instead.")
+ ): SaleCountableConnection @deprecated(reason: "Use the `promotions` query instead.")
"""
Look up a voucher by ID.
@@ -1178,7 +1229,7 @@ type Query {
"""Slug of a channel for which the data should be returned."""
channel: String
- ): Voucher @doc(category: "Discounts")
+ ): Voucher
"""
List of the shop's vouchers.
@@ -1192,8 +1243,12 @@ type Query {
"""Sort voucher."""
sortBy: VoucherSortingInput
- """Search vouchers by name or code."""
- query: String @deprecated(reason: "Use `filter.search` input instead.")
+ """
+ Search vouchers by name or code.
+
+ DEPRECATED: this field will be removed. Use `filter.search` input instead.
+ """
+ query: String
"""Slug of a channel for which the data should be returned."""
channel: String
@@ -1213,7 +1268,7 @@ type Query {
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")
+ ): VoucherCountableConnection
"""
Look up a promotion by ID.
@@ -1223,7 +1278,7 @@ type Query {
promotion(
"""ID of the promotion."""
id: ID!
- ): Promotion @doc(category: "Discounts")
+ ): Promotion
"""
List of the promotions.
@@ -1252,7 +1307,7 @@ type Query {
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
- ): PromotionCountableConnection @doc(category: "Discounts")
+ ): PromotionCountableConnection
"""
Look up a export file by ID.
@@ -1294,20 +1349,24 @@ type Query {
): ExportFileCountableConnection
"""List of all tax rates available from tax gateway."""
- taxTypes: [TaxType!] @doc(category: "Taxes") @deprecated(reason: "Use `taxClasses` field instead.")
+ taxTypes: [TaxType!] @deprecated(reason: "Use `taxClasses` field instead.")
"""
Look up a checkout by id.
- Requires one of the following permissions to query a checkout, if a checkout is in inactive channel: MANAGE_CHECKOUTS, IMPERSONATE_USER, HANDLE_PAYMENTS.
+ Requires one of the following permissions to query a checkout, if a checkout is in inactive channel: MANAGE_CHECKOUTS, IMPERSONATE_USER, HANDLE_PAYMENTS.
"""
checkout(
"""The checkout's ID."""
id: ID
- """The checkout's token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): Checkout @doc(category: "Checkout")
+ """
+ The checkout's token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): Checkout
"""
List of checkouts. The query will not initiate any external requests, including fetching external shipping methods, filtering available shipping methods, or performing external tax calculations.
@@ -1339,7 +1398,7 @@ type Query {
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")
+ ): CheckoutCountableConnection
"""
List of checkout lines. The query will not initiate any external requests, including fetching external shipping methods, filtering available shipping methods, or performing external tax calculations.
@@ -1362,7 +1421,7 @@ type Query {
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")
+ ): CheckoutLineCountableConnection
"""Look up a channel by ID or slug."""
channel(
@@ -1371,19 +1430,23 @@ type Query {
"""Slug of the channel."""
slug: String
- ): Channel @doc(category: "Channels")
+ ): Channel
"""
List of all channels.
Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
- channels: [Channel!] @doc(category: "Channels")
+ channels: [Channel!]
"""List of the shop's attributes."""
attributes(
- """Filtering options for attributes."""
- filter: AttributeFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """
+ Filtering options for attributes.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: AttributeFilterInput
"""Where filtering options for attributes."""
where: AttributeWhereInput
@@ -1412,7 +1475,7 @@ type Query {
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")
+ ): AttributeCountableConnection
"""Look up an attribute by ID, slug or external reference."""
attribute(
@@ -1424,14 +1487,14 @@ type Query {
"""External ID of the attribute."""
externalReference: String
- ): Attribute @doc(category: "Attributes")
+ ): Attribute
"""
List of all apps installations
Requires one of the following permissions: MANAGE_APPS.
"""
- appsInstallations: [AppInstallation!]! @doc(category: "Apps")
+ appsInstallations: [AppInstallation!]!
"""
List of the apps.
@@ -1460,7 +1523,7 @@ type Query {
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")
+ ): AppCountableConnection
"""
Look up an app by ID. If ID is not provided, return the currently authenticated app.
@@ -1470,7 +1533,7 @@ type Query {
app(
"""ID of the app."""
id: ID
- ): App @doc(category: "Apps")
+ ): App
"""
List of all extensions.
@@ -1496,7 +1559,7 @@ type Query {
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")
+ ): AppExtensionCountableConnection
"""
Look up an app extension by ID.
@@ -1506,7 +1569,7 @@ type Query {
appExtension(
"""ID of the app extension."""
id: ID!
- ): AppExtension @doc(category: "Apps")
+ ): AppExtension
"""Returns address validation rules."""
addressValidationRules(
@@ -1521,7 +1584,7 @@ type Query {
"""Sublocality like a district."""
cityArea: String
- ): AddressValidationData @doc(category: "Users")
+ ): AddressValidationData
"""
Look up an address by ID.
@@ -1531,7 +1594,7 @@ type Query {
address(
"""ID of an address."""
id: ID!
- ): Address @doc(category: "Users")
+ ): Address
"""
List of the shop's customers. This list includes all users who registered through the accountRegister mutation. Additionally, staff users who have placed an order using their account will also appear in this list.
@@ -1539,8 +1602,12 @@ type Query {
Requires one of the following permissions: MANAGE_ORDERS, MANAGE_USERS.
"""
customers(
- """Filtering options for customers."""
- filter: CustomerFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """
+ Filtering options for customers.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: CustomerFilterInput
"""
Where filtering options for customers.
@@ -1574,7 +1641,7 @@ type Query {
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")
+ ): UserCountableConnection
"""
List of permission groups.
@@ -1603,7 +1670,7 @@ type Query {
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")
+ ): GroupCountableConnection
"""
Look up permission group by ID.
@@ -1613,10 +1680,10 @@ type Query {
permissionGroup(
"""ID of the group."""
id: ID!
- ): Group @doc(category: "Users")
+ ): Group
"""Return the currently authenticated user."""
- me: User @doc(category: "Users")
+ me: User
"""
List of the shop's staff users.
@@ -1645,7 +1712,7 @@ type Query {
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")
+ ): UserCountableConnection
"""
Look up a user by ID or email address.
@@ -1661,13 +1728,13 @@ type Query {
"""External ID of the user."""
externalReference: String
- ): User @doc(category: "Users")
+ ): User
_entities(representations: [_Any]): [_Entity]
_service: _Service
}
"""Webhook."""
-type Webhook implements Node @doc(category: "Webhooks") {
+type Webhook implements Node {
"""The ID of webhook."""
id: ID!
@@ -1734,7 +1801,7 @@ interface Node {
}
"""Webhook event."""
-type WebhookEvent @doc(category: "Webhooks") {
+type WebhookEvent {
"""Display name of the event."""
name: String!
@@ -1743,7 +1810,7 @@ type WebhookEvent @doc(category: "Webhooks") {
}
"""Enum determining type of webhook."""
-enum WebhookEventTypeEnum @doc(category: "Webhooks") {
+enum WebhookEventTypeEnum {
"""All the events."""
ANY_EVENTS @deprecated
@@ -2244,7 +2311,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") {
}
"""Synchronous webhook event."""
-type WebhookEventSync @doc(category: "Webhooks") {
+type WebhookEventSync {
"""Display name of the event."""
name: String!
@@ -2253,7 +2320,7 @@ type WebhookEventSync @doc(category: "Webhooks") {
}
"""Enum determining type of webhook."""
-enum WebhookEventTypeSyncEnum @doc(category: "Webhooks") {
+enum WebhookEventTypeSyncEnum {
"""Listing available payment gateways."""
PAYMENT_LIST_GATEWAYS
@@ -2309,7 +2376,7 @@ enum WebhookEventTypeSyncEnum @doc(category: "Webhooks") {
}
"""Asynchronous webhook event."""
-type WebhookEventAsync @doc(category: "Webhooks") {
+type WebhookEventAsync {
"""Display name of the event."""
name: String!
@@ -2318,7 +2385,7 @@ type WebhookEventAsync @doc(category: "Webhooks") {
}
"""Enum determining type of webhook."""
-enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") {
+enum WebhookEventTypeAsyncEnum {
"""All the events."""
ANY_EVENTS @deprecated
@@ -2766,7 +2833,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") {
}
"""Represents app data."""
-type App implements Node & ObjectWithMetadata @doc(category: "Apps") {
+type App implements Node & ObjectWithMetadata {
"""The ID of the app."""
id: ID!
@@ -2872,6 +2939,18 @@ type App implements Node & ObjectWithMetadata @doc(category: "Apps") {
"""App's dashboard extensions."""
extensions: [AppExtension!]!
+ """
+ List of problems associated with this app.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: AUTHENTICATED_APP, MANAGE_APPS.
+ """
+ problems(
+ """Limit number of returned problems. Must be between 1 and 100."""
+ limit: PositiveInt
+ ): [AppProblem!]
+
"""App's brand data."""
brand: AppBrand
@@ -2944,7 +3023,7 @@ Example:
scalar Metadata
"""Represents a permission object in a friendly form."""
-type Permission @doc(category: "Authentication") {
+type Permission {
"""Internal code for permission."""
code: PermissionEnum!
@@ -2952,7 +3031,7 @@ type Permission @doc(category: "Authentication") {
name: String!
}
-enum PermissionEnum @doc(category: "Users") {
+enum PermissionEnum {
MANAGE_USERS
MANAGE_STAFF
IMPERSONATE_USER
@@ -2987,7 +3066,7 @@ value as specified by
scalar DateTime
"""Enum determining type of your App."""
-enum AppTypeEnum @doc(category: "Apps") {
+enum AppTypeEnum {
"""
Local Saleor App. The app is fully manageable from dashboard. You can change assigned permissions, add webhooks, or authentication token
"""
@@ -3000,7 +3079,7 @@ enum AppTypeEnum @doc(category: "Apps") {
}
"""Represents token data."""
-type AppToken implements Node @doc(category: "Apps") {
+type AppToken implements Node {
"""The ID of the app token."""
id: ID!
@@ -3012,7 +3091,7 @@ type AppToken implements Node @doc(category: "Apps") {
}
"""Represents app data."""
-type AppExtension implements Node @doc(category: "Apps") {
+type AppExtension implements Node {
"""The ID of the app extension."""
id: ID!
@@ -3067,7 +3146,7 @@ type AppExtension implements Node @doc(category: "Apps") {
}
"""All places where app extension can be mounted."""
-enum AppExtensionMountEnum @doc(category: "Apps") {
+enum AppExtensionMountEnum {
CATEGORY_OVERVIEW_CREATE
CATEGORY_OVERVIEW_MORE_ACTIONS
CATEGORY_DETAILS_MORE_ACTIONS
@@ -3120,13 +3199,8 @@ enum AppExtensionMountEnum @doc(category: "Apps") {
TRANSLATIONS_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") {
+"All available ways of opening an app extension.\n\n POPUP - app's extension will be mounted as a popup window\n APP_PAGE - redirect to app's page\n "
+enum AppExtensionTargetEnum {
POPUP
APP_PAGE
NEW_TAB
@@ -3138,13 +3212,13 @@ scalar JSON
union AppExtensionPossibleOptions = AppExtensionOptionsWidget | AppExtensionOptionsNewTab
"""Represents the options for an app extension."""
-type AppExtensionOptionsWidget @doc(category: "Apps") {
+type AppExtensionOptionsWidget {
"""Options for displaying a Widget"""
widgetTarget: WidgetTargetOptions @deprecated(reason: "Use `settings` field directly.")
}
"""Represents the WIDGET target options for an app extension."""
-type WidgetTargetOptions @doc(category: "Apps") {
+type WidgetTargetOptions {
"""HTTP method for Widget target (GET or POST)"""
method: HttpMethod! @deprecated(reason: "Use `settings` field directly.")
}
@@ -3155,377 +3229,122 @@ enum HttpMethod {
}
"""Represents the options for an app extension."""
-type AppExtensionOptionsNewTab @doc(category: "Apps") {
+type AppExtensionOptionsNewTab {
"""Options controlling behavior of the NEW_TAB extension target"""
newTabTarget: NewTabTargetOptions @deprecated(reason: "Use `settings` field directly.")
}
"""Represents the NEW_TAB target options for an app extension."""
-type NewTabTargetOptions @doc(category: "Apps") {
+type NewTabTargetOptions {
"""HTTP method for New Tab target (GET or POST)"""
method: HttpMethod! @deprecated(reason: "Use `settings` field directly.")
}
-"""Represents the app's brand data."""
-type AppBrand @doc(category: "Apps") {
- """App's logos details."""
- logo: AppBrandLogo!
-}
-
-"""Represents the app's brand logo data."""
-type AppBrandLogo @doc(category: "Apps") {
- """URL to the default logo image."""
- 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.
- """
- format: IconThumbnailFormatEnum = ORIGINAL
- ): String!
-}
-
-"""Thumbnail formats for icon images."""
-enum IconThumbnailFormatEnum {
- ORIGINAL
- WEBP
-}
-
-"""Enum determining the state of a circuit breaker."""
-enum CircuitBreakerStateEnum @doc(category: "Apps") {
- """The breaker is conducting (requests are passing through)."""
- CLOSED
+"""
+Represents a problem associated with an app.
+Added in Saleor 3.22.
+"""
+type AppProblem implements Node {
"""
- The breaker is in a trial period (to close or open). Note that unlike classic breaker patterns, this is not a state where we are throttling the number of requests, it's a state similar to CLOSED but with different thresholds.
+ The ID of the app problem.
+
+ Added in Saleor 3.22.
"""
- HALF_OPEN
+ id: ID!
"""
- The breaker is tripped (no requests are passing). Breaker will enter half-open state after cooldown period.
+ The date and time when the problem was created.
+
+ Added in Saleor 3.22.
"""
- OPEN
-}
-
-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 {
- """The ID of an event delivery."""
- id: ID!
-
- """Creation time of an event delivery."""
- 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") {
- """The ID of Event Delivery Attempt."""
- 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!
-}
+ """
+ The date and time when the problem was last updated.
+
+ Added in Saleor 3.22.
+ """
+ updatedAt: DateTime!
-input EventDeliveryAttemptSortingInput @doc(category: "Webhooks") {
- """Specifies the direction in which to sort attempts."""
- direction: OrderDirection!
+ """
+ Number of occurrences.
+
+ Added in Saleor 3.22.
+ """
+ count: Int!
- """Sort attempts by the selected field."""
- field: EventDeliveryAttemptSortField!
-}
+ """
+ Whether the problem has reached critical threshold.
+
+ Added in Saleor 3.22.
+ """
+ isCritical: Boolean!
-enum OrderDirection {
- """Specifies an ascending sort order."""
- ASC
+ """
+ Dismissal information. Null if the problem has not been dismissed.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: AUTHENTICATED_APP, MANAGE_APPS.
+ """
+ dismissed: AppProblemDismissed
- """Specifies a descending sort order."""
- DESC
-}
+ """
+ The problem message.
+
+ Added in Saleor 3.22.
+ """
+ message: String!
-enum EventDeliveryAttemptSortField @doc(category: "Webhooks") {
- """Sort event delivery attempts by created at."""
- CREATED_AT
+ """
+ Key identifying the type of problem.
+
+ Added in Saleor 3.22.
+ """
+ key: String!
}
-input EventDeliverySortingInput @doc(category: "Webhooks") {
- """Specifies the direction in which to sort deliveries."""
- direction: OrderDirection!
+"""
+Dismissal information for an app problem.
- """Sort deliveries by the selected field."""
- field: EventDeliverySortField!
-}
+Added in Saleor 3.22.
+"""
+type AppProblemDismissed {
+ """
+ Whether the problem was dismissed by an App or a User.
+
+ Added in Saleor 3.22.
+ """
+ by: AppProblemDismissedByEnum!
-enum EventDeliverySortField @doc(category: "Webhooks") {
- """Sort event deliveries by created at."""
- CREATED_AT
-}
+ """
+ The user who dismissed this problem. Null if dismissed by an app or the user was deleted.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: MANAGE_STAFF.
+ """
+ user: User
-input EventDeliveryFilterInput {
- status: EventDeliveryStatusEnum
- eventType: WebhookEventTypeEnum
+ """
+ Email of the user who dismissed this problem. Preserved even if the user is deleted.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
+ """
+ userEmail: String
}
-scalar JSONString
-
-enum WebhookSampleEventTypeEnum @doc(category: "Webhooks") {
- ACCOUNT_CONFIRMATION_REQUESTED
- ACCOUNT_CHANGE_EMAIL_REQUESTED
- ACCOUNT_EMAIL_CHANGED
- ACCOUNT_SET_PASSWORD_REQUESTED
- ACCOUNT_CONFIRMED
- ACCOUNT_DELETE_REQUESTED
- ACCOUNT_DELETED
- 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
- CHANNEL_METADATA_UPDATED
- GIFT_CARD_CREATED
- GIFT_CARD_UPDATED
- GIFT_CARD_DELETED
- GIFT_CARD_SENT
- GIFT_CARD_STATUS_CHANGED
- GIFT_CARD_METADATA_UPDATED
- GIFT_CARD_EXPORT_COMPLETED
- 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
- FULFILLMENT_CREATED
- FULFILLMENT_CANCELED
- FULFILLMENT_APPROVED
- FULFILLMENT_METADATA_UPDATED
- FULFILLMENT_TRACKING_NUMBER_UPDATED
- DRAFT_ORDER_CREATED
- DRAFT_ORDER_UPDATED
- DRAFT_ORDER_DELETED
- SALE_CREATED
- SALE_UPDATED
- SALE_DELETED
- SALE_TOGGLE
- PROMOTION_CREATED
- PROMOTION_UPDATED
- PROMOTION_DELETED
- PROMOTION_STARTED
- PROMOTION_ENDED
- PROMOTION_RULE_CREATED
- PROMOTION_RULE_UPDATED
- PROMOTION_RULE_DELETED
- INVOICE_REQUESTED
- INVOICE_DELETED
- INVOICE_SENT
- CUSTOMER_CREATED
- CUSTOMER_UPDATED
- CUSTOMER_DELETED
- CUSTOMER_METADATA_UPDATED
- COLLECTION_CREATED
- COLLECTION_UPDATED
- COLLECTION_DELETED
- COLLECTION_METADATA_UPDATED
- PRODUCT_CREATED
- PRODUCT_UPDATED
- PRODUCT_DELETED
- PRODUCT_METADATA_UPDATED
- PRODUCT_EXPORT_COMPLETED
- PRODUCT_MEDIA_CREATED
- PRODUCT_MEDIA_UPDATED
- PRODUCT_MEDIA_DELETED
- PRODUCT_VARIANT_CREATED
- PRODUCT_VARIANT_UPDATED
- PRODUCT_VARIANT_DELETED
- PRODUCT_VARIANT_METADATA_UPDATED
- PRODUCT_VARIANT_OUT_OF_STOCK
- PRODUCT_VARIANT_BACK_IN_STOCK
- PRODUCT_VARIANT_STOCK_UPDATED
- CHECKOUT_CREATED
- CHECKOUT_UPDATED
- CHECKOUT_FULLY_AUTHORIZED
- CHECKOUT_FULLY_PAID
- CHECKOUT_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
- STAFF_SET_PASSWORD_REQUESTED
- TRANSACTION_ITEM_METADATA_UPDATED
- TRANSLATION_CREATED
- TRANSLATION_UPDATED
- WAREHOUSE_CREATED
- WAREHOUSE_UPDATED
- WAREHOUSE_DELETED
- WAREHOUSE_METADATA_UPDATED
- VOUCHER_CREATED
- VOUCHER_UPDATED
- VOUCHER_DELETED
- VOUCHER_CODES_CREATED
- VOUCHER_CODES_DELETED
- VOUCHER_METADATA_UPDATED
- VOUCHER_CODE_EXPORT_COMPLETED
- OBSERVABILITY
- THUMBNAIL_CREATED
- SHOP_METADATA_UPDATED
+enum AppProblemDismissedByEnum {
+ APP
+ USER
}
-"""Represents warehouse."""
-type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") {
- """The ID of the warehouse."""
+"""Represents user data."""
+type User implements Node & ObjectWithMetadata {
+ """The ID of the user."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -3558,29 +3377,49 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") {
"""
metafields(keys: [String!]): Metadata
- """Warehouse name."""
- name: String!
+ """The email address of the user."""
+ email: String!
- """Warehouse slug."""
- slug: String!
+ """The given name of the address."""
+ firstName: String!
- """Warehouse email."""
- email: String!
+ """The family name of the address."""
+ lastName: String!
- """Determine if the warehouse is private."""
- isPrivate: Boolean!
+ """Determine if the user is a staff admin."""
+ isStaff: Boolean!
- """Address of the warehouse."""
- address: Address!
+ """Determine if the user is active."""
+ isActive: Boolean!
- """Warehouse company name."""
- companyName: String! @deprecated(reason: "Use `Address.companyName` instead.")
+ """Determines if user has confirmed email."""
+ isConfirmed: Boolean!
- """Click and collect options: local, all or disabled."""
- clickAndCollectOption: WarehouseClickAndCollectOptionEnum!
+ """List of all user's addresses."""
+ addresses: [Address!]!
+
+ """Returns the last open checkout of this user."""
+ checkout: Checkout @deprecated(reason: "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: "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. The query will not initiate any external requests, including fetching external shipping methods, filtering available shipping methods, or performing external tax calculations.
+ """
+ checkouts(
+ """Slug of a channel for which the data should be returned."""
+ channel: String
- """Shipping zones supported by the warehouse."""
- shippingZones(
"""Return the elements in the list that come before the specified cursor."""
before: String
@@ -3596,16 +3435,38 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") {
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!
+ ): 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
"""
- Stocks that belong to this warehouse.
-
- Added in Saleor 3.20.
+ A note about the customer.
- Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
+ Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.
"""
- stocks(
+ note: String
+
+ """
+ List of user's orders. The query will not initiate any external requests, including filtering available shipping methods, or performing external tax calculations. Requires one of the following permissions: MANAGE_STAFF, OWNER.
+ """
+ orders(
"""Return the elements in the list that come before the specified cursor."""
before: String
@@ -3621,14 +3482,87 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") {
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
+ ): OrderCountableConnection
- """External ID of this warehouse."""
+ """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.
+ """
+ accessibleChannels: [Channel!]
+
+ """
+ Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False.
+ """
+ restrictedAccessToChannels: Boolean!
+
+ """The avatar of the user."""
+ 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.
+ """
+ format: ThumbnailFormatEnum
+ ): Image
+
+ """
+ List of events associated with the user.
+
+ Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.
+ """
+ events: [CustomerEvent!]
+
+ """
+ List of stored payment sources. The field returns a list of payment sources stored for payment plugins.
+ """
+ storedPaymentSources(
+ """Slug of a channel for which the data should be returned."""
+ channel: String
+ ): [PaymentSource!]
+
+ """User language code."""
+ languageCode: LanguageCodeEnum!
+
+ """The default shipping address of the user."""
+ defaultShippingAddress: Address
+
+ """The default billing address of the user."""
+ defaultBillingAddress: Address
+
+ """External ID of this user."""
externalReference: String
+
+ """The date when the user last time log in to the system."""
+ lastLogin: DateTime
+
+ """The data when the user create account."""
+ dateJoined: DateTime!
+
+ """The data when the user last update the account information."""
+ updatedAt: DateTime!
+
+ """
+ Returns a list of user's stored payment methods that can be used in provided channel. The field returns a list of stored payment methods by payment apps. When `amount` is not provided, 0 will be used as default value.
+ """
+ storedPaymentMethods(
+ """Slug of a channel for which the data should be returned."""
+ channel: String!
+ ): [StoredPaymentMethod!]
}
"""Represents user address data."""
-type Address implements Node & ObjectWithMetadata @doc(category: "Users") {
+type Address implements Node & ObjectWithMetadata {
"""The ID of the address."""
id: ID!
@@ -3714,7 +3648,7 @@ type CountryDisplay {
}
"""Represents a VAT rate for a country."""
-type VAT @doc(category: "Taxes") {
+type VAT {
"""Country code."""
countryCode: String!
@@ -3726,7 +3660,7 @@ type VAT @doc(category: "Taxes") {
}
"""Represents a reduced VAT rate for a particular type of goods."""
-type ReducedRate @doc(category: "Taxes") {
+type ReducedRate {
"""Reduced VAT rate in percent."""
rate: Float!
@@ -3734,34 +3668,9 @@ type ReducedRate @doc(category: "Taxes") {
rateType: String!
}
-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") {
- """The ID of shipping zone."""
+"""Checkout object."""
+type Checkout implements Node & ObjectWithMetadata {
+ """The ID of the checkout."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -3794,64 +3703,211 @@ type ShippingZone implements Node & ObjectWithMetadata @doc(category: "Shipping"
"""
metafields(keys: [String!]): Metadata
- """Shipping zone name."""
- name: String!
+ """The date and time when the checkout was created."""
+ created: DateTime!
- """Indicates if the shipping zone is default one."""
- default: Boolean!
+ """Time of last modification of the given checkout."""
+ updatedAt: DateTime!
+ lastChange: DateTime! @deprecated(reason: "Use `updatedAt` instead.")
- """Lowest and highest prices for the shipping."""
- priceRange: MoneyRange
+ """
+ The user assigned to the checkout. Requires one of the following permissions: MANAGE_USERS, HANDLE_PAYMENTS, OWNER.
+ """
+ user: User
- """List of countries available for the method."""
- countries: [CountryDisplay!]!
+ """The channel for which checkout was created."""
+ channel: Channel!
+
+ """The billing address of the checkout."""
+ billingAddress: Address
+
+ """The shipping address of the checkout."""
+ shippingAddress: Address
"""
- List of shipping methods available for orders shipped to countries within this shipping zone.
+ The customer note for the checkout.
+
+ Added in Saleor 3.21.
"""
- shippingMethods: [ShippingMethodType!]
+ customerNote: String!
- """List of warehouses for shipping zone."""
- warehouses: [Warehouse!]!
+ """The note for the checkout."""
+ note: String! @deprecated(reason: "Use `customerNote` instead.")
- """List of channels for shipping zone."""
- channels: [Channel!]!
+ """
+ The total discount applied to the checkout. Note: Only discount created via voucher are included in this field.
+ """
+ discount: Money
- """Description of a shipping zone."""
- description: String
-}
+ """The name of voucher assigned to the checkout."""
+ discountName: String
-"""Represents a range of amounts of money."""
-type MoneyRange {
- """Lower bound of a price range."""
- start: Money
+ """
+ Translation of the discountName field in the language set in Checkout.languageCode field.Note: this field is set automatically when Checkout.languageCode is defined; otherwise it's null
+ """
+ translatedDiscountName: String
- """Upper bound of a price range."""
- stop: Money
-}
+ """
+ The voucher assigned to the checkout.
+
+ Added in Saleor 3.18.
+
+ Requires one of the following permissions: MANAGE_DISCOUNTS.
+ """
+ voucher: Voucher
-"""Represents amount of money in specific currency."""
-type Money {
- """Currency code."""
- currency: String!
+ """The code of voucher assigned to the checkout."""
+ voucherCode: String
- """Amount of money."""
- amount: Float!
+ """
+ Shipping methods that can be used with this checkout.
+
+ Triggers the following webhook events:
+ - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
+ - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
+ """
+ availableShippingMethods: [ShippingMethod!]! @deprecated(reason: "Use `shippingMethods` instead.")
"""
- Amount of money represented as an integer in the smallest currency unit.
+ Shipping methods that can be used with this checkout.
+
+ Triggers the following webhook events:
+ - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
+ - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
"""
- fractionalAmount: Int!
+ shippingMethods: [ShippingMethod!]!
- """Number of digits after the decimal point in the currency."""
- fractionDigits: Int!
+ """Collection points that can be used for this order."""
+ availableCollectionPoints: [Warehouse!]!
+
+ """
+ List of available payment gateways.
+
+ Triggers the following webhook events:
+ - PAYMENT_LIST_GATEWAYS (sync): Fetch payment gateways available for checkout.
+ """
+ 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.
+ """
+ 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. Set to 0 when no delivery method is selected.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ shippingPrice: TaxedMoney!
+
+ """
+ The shipping method related with checkout.
+
+ Triggers the following webhook events:
+ - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
+ - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
+ """
+ shippingMethod: ShippingMethod @deprecated(reason: "Use `deliveryMethod` instead.")
+
+ """
+ The delivery method selected for this checkout.
+
+ Triggers the following webhook events:
+ - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
+ - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
+ """
+ deliveryMethod: DeliveryMethod
+
+ """
+ The price of the checkout before shipping, with taxes included.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ subtotalPrice: TaxedMoney!
+
+ """Returns True if checkout has to be exempt from taxes."""
+ taxExemption: Boolean!
+
+ """The checkout's token."""
+ token: UUID!
+
+ """
+ The sum of the checkout line prices, with all the taxes,shipping costs, and discounts included.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ totalPrice: TaxedMoney!
+
+ """
+ The difference between the paid and the checkout total amount.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ totalBalance: Money!
+
+ """Checkout language code."""
+ languageCode: LanguageCodeEnum!
+
+ """
+ List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS.
+ """
+ transactions: [TransactionItem!]
+
+ """Determines whether displayed prices should include taxes."""
+ displayGrossPrices: Boolean!
+
+ """
+ The authorize status of the checkout.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ authorizeStatus: CheckoutAuthorizeStatusEnum!
+
+ """
+ The charge status of the checkout.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ chargeStatus: CheckoutChargeStatusEnum!
+
+ """
+ List of user's stored payment methods that can be used in this checkout session. It uses the channel that the checkout was created in. When `amount` is not provided, `checkout.total` will be used as a default value.
+ """
+ storedPaymentMethods(
+ """Amount that will be used to fetch stored payment methods."""
+ amount: PositiveDecimal
+ ): [StoredPaymentMethod!]
+
+ """List of problems with the checkout."""
+ problems: [CheckoutProblem!]
}
-"""
-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."""
+"""Represents channel."""
+type Channel implements Node & ObjectWithMetadata {
+ """The ID of the channel."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -3884,110 +3940,472 @@ type ShippingMethodType implements Node & ObjectWithMetadata @doc(category: "Shi
"""
metafields(keys: [String!]): Metadata
- """Shipping method name."""
- name: String!
+ """Slug of the channel."""
+ slug: String!
"""
- Shipping method description.
+ Name of the channel.
- Rich text format. For reference see https://editorjs.io/
+ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
- 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
+ name: String!
"""
- List of channels available for the method.
+ Whether the channel is active.
- Requires one of the following permissions: MANAGE_SHIPPING.
+ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
- channelListings: [ShippingMethodChannelListing!]
-
- """The price of the cheapest variant (including discounts)."""
- maximumOrderPrice: Money
-
- """The price of the cheapest variant (including discounts)."""
- minimumOrderPrice: Money
+ isActive: Boolean!
"""
- Postal code ranges rule of exclusion or inclusion of the shipping method.
+ A currency that is assigned to the channel.
+
+ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
- postalCodeRules: [ShippingMethodPostalCodeRule!]
+ currencyCode: String!
"""
- List of excluded products for the shipping method.
+ Whether a channel has associated orders.
- Requires one of the following permissions: MANAGE_SHIPPING.
+ Requires one of the following permissions: MANAGE_CHANNELS.
"""
- 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
+ hasOrders: Boolean!
"""
- Tax class assigned to this shipping method.
+ 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.
- Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
- taxClass: TaxClass
-}
-
-enum ShippingMethodTypeEnum @doc(category: "Shipping") {
- PRICE
- WEIGHT
-}
+ defaultCountry: CountryDisplay!
-"""Represents shipping method translations."""
-type ShippingMethodTranslation implements Node @doc(category: "Shipping") {
- """The ID of the shipping method translation."""
- id: ID!
+ """
+ List of warehouses assigned to this channel.
+
+ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ """
+ warehouses: [Warehouse!]!
- """Translation language."""
- language: LanguageDisplay!
+ """List of shippable countries for the channel."""
+ countries: [CountryDisplay!]
- """Translated shipping method name."""
- name: String
+ """Shipping methods that are available for the channel."""
+ availableShippingMethodsPerCountry(countries: [CountryCode!]): [ShippingMethodsPerCountry!]
"""
- Translated description of the shipping method.
+ Define the stock setting for this channel.
- Rich text format. For reference see https://editorjs.io/
+ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
"""
- description: JSONString
+ stockSettings: StockSettings!
- """Represents the shipping method fields to translate."""
+ """
+ Channel-specific order settings.
+
+ Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_ORDERS.
+ """
+ orderSettings: OrderSettings!
+
+ """
+ Channel-specific checkout settings.
+
+ Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_CHECKOUTS.
+ """
+ checkoutSettings: CheckoutSettings!
+
+ """
+ Channel-specific payment settings.
+
+ Requires one of the following permissions: MANAGE_CHANNELS, HANDLE_PAYMENTS.
+ """
+ paymentSettings: PaymentSettings!
+
+ """
+ Channel specific tax configuration.
+
+ Added in Saleor 3.20.
+
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ """
+ taxConfiguration: TaxConfiguration!
+}
+
+"""Represents warehouse."""
+type Warehouse implements Node & ObjectWithMetadata {
+ """The ID of the warehouse."""
+ 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
+
+ """Warehouse name."""
+ name: String!
+
+ """Warehouse slug."""
+ slug: String!
+
+ """Warehouse email."""
+ email: String!
+
+ """Determine if the warehouse is private."""
+ isPrivate: Boolean!
+
+ """Address of the warehouse."""
+ address: Address!
+
+ """Warehouse company name."""
+ companyName: String! @deprecated(reason: "Use `Address.companyName` instead.")
+
+ """Click and collect options: local, all or disabled."""
+ clickAndCollectOption: WarehouseClickAndCollectOptionEnum!
+
+ """Shipping zones supported by the warehouse."""
+ 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!
+
+ """
+ Stocks that belong to this warehouse.
+
+ Added in Saleor 3.20.
+
+ Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
+ """
+ stocks(
+ """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
+
+ """External ID of this warehouse."""
+ externalReference: String
+}
+
+enum WarehouseClickAndCollectOptionEnum {
+ DISABLED
+ LOCAL
+ ALL
+}
+
+type ShippingZoneCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [ShippingZoneCountableEdge!]!
+
+ """A total count of items in the collection."""
+ totalCount: Int
+}
+
+"""
+The Relay compliant `PageInfo` type, containing data necessary to paginate this connection.
+"""
+type PageInfo {
+ """When paginating forwards, are there more items?"""
+ hasNextPage: Boolean!
+
+ """When paginating backwards, are there more items?"""
+ hasPreviousPage: Boolean!
+
+ """When paginating backwards, the cursor to continue."""
+ startCursor: String
+
+ """When paginating forwards, the cursor to continue."""
+ endCursor: String
+}
+
+type ShippingZoneCountableEdge {
+ """The item at the end of the edge."""
+ node: ShippingZone!
+
+ """A cursor for use in pagination."""
+ cursor: String!
+}
+
+"""
+Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly.
+"""
+type ShippingZone implements Node & ObjectWithMetadata {
+ """The ID of shipping zone."""
+ 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
+
+ """Shipping zone name."""
+ name: String!
+
+ """Indicates if the shipping zone is default one."""
+ 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!
+
+ """
+ Amount of money represented as an integer in the smallest currency unit.
+ """
+ fractionalAmount: Int!
+
+ """Number of digits after the decimal point in the currency."""
+ fractionDigits: Int!
+}
+
+"""
+Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers.
+"""
+type ShippingMethodType implements Node & ObjectWithMetadata {
+ """Shipping method ID."""
+ id: ID!
+
+ """List of private metadata items. Requires staff permissions to access."""
+ privateMetadata: [MetadataItem!]!
+
+ """
+ A single key from private metadata. Requires staff permissions to access.
+
+ Tip: Use GraphQL aliases to fetch multiple keys.
+ """
+ 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
+
+ """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
+}
+
+scalar JSONString
+
+enum ShippingMethodTypeEnum {
+ PRICE
+ WEIGHT
+}
+
+"""Represents shipping method translations."""
+type ShippingMethodTranslation implements Node {
+ """The ID of the shipping method translation."""
+ id: ID!
+
+ """Translation language."""
+ language: LanguageDisplay!
+
+ """Translated shipping method name."""
+ name: String
+
+ """
+ Translated description of the shipping method.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ description: JSONString
+
+ """Represents the shipping method fields to translate."""
translatableContent: ShippingMethodTranslatableContent
}
@@ -3999,792 +4417,2350 @@ type LanguageDisplay {
language: String!
}
+"""Language code enum. It contains all the languages supported by Saleor."""
enum LanguageCodeEnum {
+ """Afrikaans"""
AF
+
+ """Afrikaans (Namibia)"""
AF_NA
+
+ """Afrikaans (South Africa)"""
AF_ZA
+
+ """Aghem"""
AGQ
+
+ """Aghem (Cameroon)"""
AGQ_CM
+
+ """Akan"""
AK
+
+ """Akan (Ghana)"""
AK_GH
+
+ """Amharic"""
AM
+
+ """Amharic (Ethiopia)"""
AM_ET
+
+ """Arabic"""
AR
+
+ """Arabic (United Arab Emirates)"""
AR_AE
+
+ """Arabic (Bahrain)"""
AR_BH
+
+ """Arabic (Djibouti)"""
AR_DJ
+
+ """Arabic (Algeria)"""
AR_DZ
+
+ """Arabic (Egypt)"""
AR_EG
+
+ """Arabic (Western Sahara)"""
AR_EH
+
+ """Arabic (Eritrea)"""
AR_ER
+
+ """Arabic (Israel)"""
AR_IL
+
+ """Arabic (Iraq)"""
AR_IQ
+
+ """Arabic (Jordan)"""
AR_JO
+
+ """Arabic (Comoros)"""
AR_KM
+
+ """Arabic (Kuwait)"""
AR_KW
+
+ """Arabic (Lebanon)"""
AR_LB
+
+ """Arabic (Libya)"""
AR_LY
+
+ """Arabic (Morocco)"""
AR_MA
+
+ """Arabic (Mauritania)"""
AR_MR
+
+ """Arabic (Oman)"""
AR_OM
+
+ """Arabic (Palestinian Territories)"""
AR_PS
+
+ """Arabic (Qatar)"""
AR_QA
+
+ """Arabic (Saudi Arabia)"""
AR_SA
+
+ """Arabic (Sudan)"""
AR_SD
+
+ """Arabic (Somalia)"""
AR_SO
+
+ """Arabic (South Sudan)"""
AR_SS
+
+ """Arabic (Syria)"""
AR_SY
+
+ """Arabic (Chad)"""
AR_TD
+
+ """Arabic (Tunisia)"""
AR_TN
+
+ """Arabic (Yemen)"""
AR_YE
+
+ """Assamese"""
AS
+
+ """Assamese (India)"""
AS_IN
+
+ """Asu"""
ASA
+
+ """Asu (Tanzania)"""
ASA_TZ
+
+ """Asturian"""
AST
+
+ """Asturian (Spain)"""
AST_ES
+
+ """Azerbaijani"""
AZ
+
+ """Azerbaijani (Cyrillic)"""
AZ_CYRL
+
+ """Azerbaijani (Cyrillic, Azerbaijan)"""
AZ_CYRL_AZ
+
+ """Azerbaijani (Latin)"""
AZ_LATN
+
+ """Azerbaijani (Latin, Azerbaijan)"""
AZ_LATN_AZ
+
+ """Basaa"""
BAS
+
+ """Basaa (Cameroon)"""
BAS_CM
+
+ """Belarusian"""
BE
+
+ """Belarusian (Belarus)"""
BE_BY
+
+ """Bemba"""
BEM
+
+ """Bemba (Zambia)"""
BEM_ZM
+
+ """Bena"""
BEZ
+
+ """Bena (Tanzania)"""
BEZ_TZ
+
+ """Bulgarian"""
BG
+
+ """Bulgarian (Bulgaria)"""
BG_BG
+
+ """Bambara"""
BM
+
+ """Bambara (Mali)"""
BM_ML
+
+ """Bangla"""
BN
+
+ """Bangla (Bangladesh)"""
BN_BD
+
+ """Bangla (India)"""
BN_IN
+
+ """Tibetan"""
BO
+
+ """Tibetan (China)"""
BO_CN
+
+ """Tibetan (India)"""
BO_IN
+
+ """Breton"""
BR
+
+ """Breton (France)"""
BR_FR
+
+ """Bodo"""
BRX
+
+ """Bodo (India)"""
BRX_IN
+
+ """Bosnian"""
BS
+
+ """Bosnian (Cyrillic)"""
BS_CYRL
+
+ """Bosnian (Cyrillic, Bosnia & Herzegovina)"""
BS_CYRL_BA
+
+ """Bosnian (Latin)"""
BS_LATN
+
+ """Bosnian (Latin, Bosnia & Herzegovina)"""
BS_LATN_BA
+
+ """Catalan"""
CA
+
+ """Catalan (Andorra)"""
CA_AD
+
+ """Catalan (Spain)"""
CA_ES
+
+ """Catalan (Spain, Valencian)"""
CA_ES_VALENCIA
+
+ """Catalan (France)"""
CA_FR
+
+ """Catalan (Italy)"""
CA_IT
+
+ """Chakma"""
CCP
+
+ """Chakma (Bangladesh)"""
CCP_BD
+
+ """Chakma (India)"""
CCP_IN
+
+ """Chechen"""
CE
+
+ """Chechen (Russia)"""
CE_RU
+
+ """Cebuano"""
CEB
+
+ """Cebuano (Philippines)"""
CEB_PH
+
+ """Chiga"""
CGG
+
+ """Chiga (Uganda)"""
CGG_UG
+
+ """Cherokee"""
CHR
+
+ """Cherokee (United States)"""
CHR_US
+
+ """Central Kurdish"""
CKB
+
+ """Central Kurdish (Iraq)"""
CKB_IQ
+
+ """Central Kurdish (Iran)"""
CKB_IR
+
+ """Czech"""
CS
+
+ """Czech (Czechia)"""
CS_CZ
+
+ """Church Slavic"""
CU
+
+ """Church Slavic (Russia)"""
CU_RU
+
+ """Welsh"""
CY
+
+ """Welsh (United Kingdom)"""
CY_GB
+
+ """Danish"""
DA
+
+ """Danish (Denmark)"""
DA_DK
+
+ """Danish (Greenland)"""
DA_GL
+
+ """Taita"""
DAV
+
+ """Taita (Kenya)"""
DAV_KE
+
+ """German"""
DE
+
+ """German (Austria)"""
DE_AT
+
+ """German (Belgium)"""
DE_BE
+
+ """German (Switzerland)"""
DE_CH
+
+ """German (Germany)"""
DE_DE
+
+ """German (Italy)"""
DE_IT
+
+ """German (Liechtenstein)"""
DE_LI
+
+ """German (Luxembourg)"""
DE_LU
+
+ """Zarma"""
DJE
+
+ """Zarma (Niger)"""
DJE_NE
+
+ """Lower Sorbian"""
DSB
+
+ """Lower Sorbian (Germany)"""
DSB_DE
+
+ """Duala"""
DUA
+
+ """Duala (Cameroon)"""
DUA_CM
+
+ """Jola-Fonyi"""
DYO
+
+ """Jola-Fonyi (Senegal)"""
DYO_SN
+
+ """Dzongkha"""
DZ
+
+ """Dzongkha (Bhutan)"""
DZ_BT
+
+ """Embu"""
EBU
+
+ """Embu (Kenya)"""
EBU_KE
+
+ """Ewe"""
EE
+
+ """Ewe (Ghana)"""
EE_GH
+
+ """Ewe (Togo)"""
EE_TG
+
+ """Greek"""
EL
+
+ """Greek (Cyprus)"""
EL_CY
+
+ """Greek (Greece)"""
EL_GR
+
+ """English"""
EN
+
+ """English (United Arab Emirates)"""
EN_AE
+
+ """English (Antigua & Barbuda)"""
EN_AG
+
+ """English (Anguilla)"""
EN_AI
+
+ """English (American Samoa)"""
EN_AS
+
+ """English (Austria)"""
EN_AT
+
+ """English (Australia)"""
EN_AU
+
+ """English (Barbados)"""
EN_BB
+
+ """English (Belgium)"""
EN_BE
+
+ """English (Burundi)"""
EN_BI
+
+ """English (Bermuda)"""
EN_BM
+
+ """English (Bahamas)"""
EN_BS
+
+ """English (Botswana)"""
EN_BW
+
+ """English (Belize)"""
EN_BZ
+
+ """English (Canada)"""
EN_CA
+
+ """English (Cocos (Keeling) Islands)"""
EN_CC
+
+ """English (Switzerland)"""
EN_CH
+
+ """English (Cook Islands)"""
EN_CK
+
+ """English (Cameroon)"""
EN_CM
+
+ """English (Christmas Island)"""
EN_CX
+
+ """English (Cyprus)"""
EN_CY
+
+ """English (Germany)"""
EN_DE
+
+ """English (Diego Garcia)"""
EN_DG
+
+ """English (Denmark)"""
EN_DK
+
+ """English (Dominica)"""
EN_DM
+
+ """English (Eritrea)"""
EN_ER
+
+ """English (Finland)"""
EN_FI
+
+ """English (Fiji)"""
EN_FJ
+
+ """English (Falkland Islands)"""
EN_FK
+
+ """English (Micronesia)"""
EN_FM
+
+ """English (United Kingdom)"""
EN_GB
+
+ """English (Grenada)"""
EN_GD
+
+ """English (Guernsey)"""
EN_GG
+
+ """English (Ghana)"""
EN_GH
+
+ """English (Gibraltar)"""
EN_GI
+
+ """English (Gambia)"""
EN_GM
+
+ """English (Guam)"""
EN_GU
+
+ """English (Guyana)"""
EN_GY
+
+ """English (Hong Kong SAR China)"""
EN_HK
+
+ """English (Ireland)"""
EN_IE
+
+ """English (Israel)"""
EN_IL
+
+ """English (Isle of Man)"""
EN_IM
+
+ """English (India)"""
EN_IN
+
+ """English (British Indian Ocean Territory)"""
EN_IO
+
+ """English (Jersey)"""
EN_JE
+
+ """English (Jamaica)"""
EN_JM
+
+ """English (Kenya)"""
EN_KE
+
+ """English (Kiribati)"""
EN_KI
+
+ """English (St. Kitts & Nevis)"""
EN_KN
+
+ """English (Cayman Islands)"""
EN_KY
+
+ """English (St. Lucia)"""
EN_LC
+
+ """English (Liberia)"""
EN_LR
+
+ """English (Lesotho)"""
EN_LS
+
+ """English (Madagascar)"""
EN_MG
+
+ """English (Marshall Islands)"""
EN_MH
+
+ """English (Macao SAR China)"""
EN_MO
+
+ """English (Northern Mariana Islands)"""
EN_MP
+
+ """English (Montserrat)"""
EN_MS
+
+ """English (Malta)"""
EN_MT
+
+ """English (Mauritius)"""
EN_MU
+
+ """English (Malawi)"""
EN_MW
+
+ """English (Malaysia)"""
EN_MY
+
+ """English (Namibia)"""
EN_NA
+
+ """English (Norfolk Island)"""
EN_NF
+
+ """English (Nigeria)"""
EN_NG
+
+ """English (Netherlands)"""
EN_NL
+
+ """English (Nauru)"""
EN_NR
+
+ """English (Niue)"""
EN_NU
+
+ """English (New Zealand)"""
EN_NZ
+
+ """English (Papua New Guinea)"""
EN_PG
+
+ """English (Philippines)"""
EN_PH
+
+ """English (Pakistan)"""
EN_PK
+
+ """English (Pitcairn Islands)"""
EN_PN
+
+ """English (Puerto Rico)"""
EN_PR
+
+ """English (Palau)"""
EN_PW
+
+ """English (Rwanda)"""
EN_RW
+
+ """English (Solomon Islands)"""
EN_SB
+
+ """English (Seychelles)"""
EN_SC
+
+ """English (Sudan)"""
EN_SD
+
+ """English (Sweden)"""
EN_SE
+
+ """English (Singapore)"""
EN_SG
+
+ """English (St. Helena)"""
EN_SH
+
+ """English (Slovenia)"""
EN_SI
+
+ """English (Sierra Leone)"""
EN_SL
+
+ """English (South Sudan)"""
EN_SS
+
+ """English (Sint Maarten)"""
EN_SX
+
+ """English (Eswatini)"""
EN_SZ
+
+ """English (Turks & Caicos Islands)"""
EN_TC
+
+ """English (Tokelau)"""
EN_TK
+
+ """English (Tonga)"""
EN_TO
+
+ """English (Trinidad & Tobago)"""
EN_TT
+
+ """English (Tuvalu)"""
EN_TV
+
+ """English (Tanzania)"""
EN_TZ
+
+ """English (Uganda)"""
EN_UG
+
+ """English (U.S. Outlying Islands)"""
EN_UM
+
+ """English (United States)"""
EN_US
+
+ """English (St. Vincent & Grenadines)"""
EN_VC
+
+ """English (British Virgin Islands)"""
EN_VG
+
+ """English (U.S. Virgin Islands)"""
EN_VI
+
+ """English (Vanuatu)"""
EN_VU
+
+ """English (Samoa)"""
EN_WS
+
+ """English (South Africa)"""
EN_ZA
+
+ """English (Zambia)"""
EN_ZM
+
+ """English (Zimbabwe)"""
EN_ZW
+
+ """Esperanto"""
EO
+
+ """Spanish"""
ES
+
+ """Spanish (Argentina)"""
ES_AR
+
+ """Spanish (Bolivia)"""
ES_BO
+
+ """Spanish (Brazil)"""
ES_BR
+
+ """Spanish (Belize)"""
ES_BZ
+
+ """Spanish (Chile)"""
ES_CL
+
+ """Spanish (Colombia)"""
ES_CO
+
+ """Spanish (Costa Rica)"""
ES_CR
+
+ """Spanish (Cuba)"""
ES_CU
+
+ """Spanish (Dominican Republic)"""
ES_DO
+
+ """Spanish (Ceuta & Melilla)"""
ES_EA
+
+ """Spanish (Ecuador)"""
ES_EC
+
+ """Spanish (Spain)"""
ES_ES
+
+ """Spanish (Equatorial Guinea)"""
ES_GQ
+
+ """Spanish (Guatemala)"""
ES_GT
+
+ """Spanish (Honduras)"""
ES_HN
+
+ """Spanish (Canary Islands)"""
ES_IC
+
+ """Spanish (Mexico)"""
ES_MX
+
+ """Spanish (Nicaragua)"""
ES_NI
+
+ """Spanish (Panama)"""
ES_PA
+
+ """Spanish (Peru)"""
ES_PE
+
+ """Spanish (Philippines)"""
ES_PH
+
+ """Spanish (Puerto Rico)"""
ES_PR
+
+ """Spanish (Paraguay)"""
ES_PY
+
+ """Spanish (El Salvador)"""
ES_SV
+
+ """Spanish (United States)"""
ES_US
+
+ """Spanish (Uruguay)"""
ES_UY
+
+ """Spanish (Venezuela)"""
ES_VE
+
+ """Estonian"""
ET
+
+ """Estonian (Estonia)"""
ET_EE
+
+ """Basque"""
EU
+
+ """Basque (Spain)"""
EU_ES
+
+ """Ewondo"""
EWO
+
+ """Ewondo (Cameroon)"""
EWO_CM
+
+ """Persian"""
FA
+
+ """Persian (Afghanistan)"""
FA_AF
+
+ """Persian (Iran)"""
FA_IR
+
+ """Fulah"""
FF
+
+ """Fulah (Adlam)"""
FF_ADLM
+
+ """Fulah (Adlam, Burkina Faso)"""
FF_ADLM_BF
+
+ """Fulah (Adlam, Cameroon)"""
FF_ADLM_CM
+
+ """Fulah (Adlam, Ghana)"""
FF_ADLM_GH
+
+ """Fulah (Adlam, Gambia)"""
FF_ADLM_GM
+
+ """Fulah (Adlam, Guinea)"""
FF_ADLM_GN
+
+ """Fulah (Adlam, Guinea-Bissau)"""
FF_ADLM_GW
+
+ """Fulah (Adlam, Liberia)"""
FF_ADLM_LR
+
+ """Fulah (Adlam, Mauritania)"""
FF_ADLM_MR
+
+ """Fulah (Adlam, Niger)"""
FF_ADLM_NE
+
+ """Fulah (Adlam, Nigeria)"""
FF_ADLM_NG
+
+ """Fulah (Adlam, Sierra Leone)"""
FF_ADLM_SL
+
+ """Fulah (Adlam, Senegal)"""
FF_ADLM_SN
+
+ """Fulah (Latin)"""
FF_LATN
+
+ """Fulah (Latin, Burkina Faso)"""
FF_LATN_BF
+
+ """Fulah (Latin, Cameroon)"""
FF_LATN_CM
+
+ """Fulah (Latin, Ghana)"""
FF_LATN_GH
+
+ """Fulah (Latin, Gambia)"""
FF_LATN_GM
+
+ """Fulah (Latin, Guinea)"""
FF_LATN_GN
+
+ """Fulah (Latin, Guinea-Bissau)"""
FF_LATN_GW
+
+ """Fulah (Latin, Liberia)"""
FF_LATN_LR
+
+ """Fulah (Latin, Mauritania)"""
FF_LATN_MR
+
+ """Fulah (Latin, Niger)"""
FF_LATN_NE
+
+ """Fulah (Latin, Nigeria)"""
FF_LATN_NG
+
+ """Fulah (Latin, Sierra Leone)"""
FF_LATN_SL
+
+ """Fulah (Latin, Senegal)"""
FF_LATN_SN
+
+ """Finnish"""
FI
+
+ """Finnish (Finland)"""
FI_FI
+
+ """Filipino"""
FIL
+
+ """Filipino (Philippines)"""
FIL_PH
+
+ """Faroese"""
FO
+
+ """Faroese (Denmark)"""
FO_DK
+
+ """Faroese (Faroe Islands)"""
FO_FO
+
+ """French"""
FR
+
+ """French (Belgium)"""
FR_BE
+
+ """French (Burkina Faso)"""
FR_BF
+
+ """French (Burundi)"""
FR_BI
+
+ """French (Benin)"""
FR_BJ
+
+ """French (St. Barthélemy)"""
FR_BL
+
+ """French (Canada)"""
FR_CA
+
+ """French (Congo - Kinshasa)"""
FR_CD
+
+ """French (Central African Republic)"""
FR_CF
+
+ """French (Congo - Brazzaville)"""
FR_CG
+
+ """French (Switzerland)"""
FR_CH
+
+ """French (Côte d’Ivoire)"""
FR_CI
+
+ """French (Cameroon)"""
FR_CM
+
+ """French (Djibouti)"""
FR_DJ
+
+ """French (Algeria)"""
FR_DZ
+
+ """French (France)"""
FR_FR
+
+ """French (Gabon)"""
FR_GA
+
+ """French (French Guiana)"""
FR_GF
+
+ """French (Guinea)"""
FR_GN
+
+ """French (Guadeloupe)"""
FR_GP
+
+ """French (Equatorial Guinea)"""
FR_GQ
+
+ """French (Haiti)"""
FR_HT
+
+ """French (Comoros)"""
FR_KM
+
+ """French (Luxembourg)"""
FR_LU
+
+ """French (Morocco)"""
FR_MA
+
+ """French (Monaco)"""
FR_MC
+
+ """French (St. Martin)"""
FR_MF
+
+ """French (Madagascar)"""
FR_MG
+
+ """French (Mali)"""
FR_ML
+
+ """French (Martinique)"""
FR_MQ
+
+ """French (Mauritania)"""
FR_MR
+
+ """French (Mauritius)"""
FR_MU
+
+ """French (New Caledonia)"""
FR_NC
+
+ """French (Niger)"""
FR_NE
+
+ """French (French Polynesia)"""
FR_PF
+
+ """French (St. Pierre & Miquelon)"""
FR_PM
+
+ """French (Réunion)"""
FR_RE
+
+ """French (Rwanda)"""
FR_RW
+
+ """French (Seychelles)"""
FR_SC
+
+ """French (Senegal)"""
FR_SN
+
+ """French (Syria)"""
FR_SY
+
+ """French (Chad)"""
FR_TD
+
+ """French (Togo)"""
FR_TG
+
+ """French (Tunisia)"""
FR_TN
+
+ """French (Vanuatu)"""
FR_VU
+
+ """French (Wallis & Futuna)"""
FR_WF
+
+ """French (Mayotte)"""
FR_YT
+
+ """Friulian"""
FUR
+
+ """Friulian (Italy)"""
FUR_IT
+
+ """Western Frisian"""
FY
+
+ """Western Frisian (Netherlands)"""
FY_NL
+
+ """Irish"""
GA
+
+ """Irish (United Kingdom)"""
GA_GB
+
+ """Irish (Ireland)"""
GA_IE
+
+ """Scottish Gaelic"""
GD
+
+ """Scottish Gaelic (United Kingdom)"""
GD_GB
+
+ """Galician"""
GL
+
+ """Galician (Spain)"""
GL_ES
+
+ """Swiss German"""
GSW
+
+ """Swiss German (Switzerland)"""
GSW_CH
+
+ """Swiss German (France)"""
GSW_FR
+
+ """Swiss German (Liechtenstein)"""
GSW_LI
+
+ """Gujarati"""
GU
+
+ """Gujarati (India)"""
GU_IN
+
+ """Gusii"""
GUZ
+
+ """Gusii (Kenya)"""
GUZ_KE
+
+ """Manx"""
GV
+
+ """Manx (Isle of Man)"""
GV_IM
+
+ """Hausa"""
HA
+
+ """Hausa (Ghana)"""
HA_GH
+
+ """Hausa (Niger)"""
HA_NE
+
+ """Hausa (Nigeria)"""
HA_NG
+
+ """Hawaiian"""
HAW
+
+ """Hawaiian (United States)"""
HAW_US
+
+ """Hebrew"""
HE
+
+ """Hebrew (Israel)"""
HE_IL
+
+ """Hindi"""
HI
+
+ """Hindi (India)"""
HI_IN
+
+ """Croatian"""
HR
+
+ """Croatian (Bosnia & Herzegovina)"""
HR_BA
+
+ """Croatian (Croatia)"""
HR_HR
+
+ """Upper Sorbian"""
HSB
+
+ """Upper Sorbian (Germany)"""
HSB_DE
+
+ """Hungarian"""
HU
+
+ """Hungarian (Hungary)"""
HU_HU
+
+ """Armenian"""
HY
+
+ """Armenian (Armenia)"""
HY_AM
+
+ """Interlingua"""
IA
+
+ """Indonesian"""
ID
+
+ """Indonesian (Indonesia)"""
ID_ID
+
+ """Igbo"""
IG
+
+ """Igbo (Nigeria)"""
IG_NG
+
+ """Sichuan Yi"""
II
+
+ """Sichuan Yi (China)"""
II_CN
+
+ """Icelandic"""
IS
+
+ """Icelandic (Iceland)"""
IS_IS
+
+ """Italian"""
IT
+
+ """Italian (Switzerland)"""
IT_CH
+
+ """Italian (Italy)"""
IT_IT
+
+ """Italian (San Marino)"""
IT_SM
+
+ """Italian (Vatican City)"""
IT_VA
+
+ """Japanese"""
JA
+
+ """Japanese (Japan)"""
JA_JP
+
+ """Ngomba"""
JGO
+
+ """Ngomba (Cameroon)"""
JGO_CM
+
+ """Machame"""
JMC
+
+ """Machame (Tanzania)"""
JMC_TZ
+
+ """Javanese"""
JV
+
+ """Javanese (Indonesia)"""
JV_ID
+
+ """Georgian"""
KA
+
+ """Georgian (Georgia)"""
KA_GE
+
+ """Kabyle"""
KAB
+
+ """Kabyle (Algeria)"""
KAB_DZ
+
+ """Kamba"""
KAM
+
+ """Kamba (Kenya)"""
KAM_KE
+
+ """Makonde"""
KDE
+
+ """Makonde (Tanzania)"""
KDE_TZ
+
+ """Kabuverdianu"""
KEA
+
+ """Kabuverdianu (Cape Verde)"""
KEA_CV
+
+ """Koyra Chiini"""
KHQ
+
+ """Koyra Chiini (Mali)"""
KHQ_ML
+
+ """Kikuyu"""
KI
+
+ """Kikuyu (Kenya)"""
KI_KE
+
+ """Kazakh"""
KK
+
+ """Kazakh (Kazakhstan)"""
KK_KZ
+
+ """Kako"""
KKJ
+
+ """Kako (Cameroon)"""
KKJ_CM
+
+ """Kalaallisut"""
KL
+
+ """Kalaallisut (Greenland)"""
KL_GL
+
+ """Kalenjin"""
KLN
+
+ """Kalenjin (Kenya)"""
KLN_KE
+
+ """Khmer"""
KM
+
+ """Khmer (Cambodia)"""
KM_KH
+
+ """Kannada"""
KN
+
+ """Kannada (India)"""
KN_IN
+
+ """Korean"""
KO
+
+ """Korean (North Korea)"""
KO_KP
+
+ """Korean (South Korea)"""
KO_KR
+
+ """Konkani"""
KOK
+
+ """Konkani (India)"""
KOK_IN
+
+ """Kashmiri"""
KS
+
+ """Kashmiri (Arabic)"""
KS_ARAB
+
+ """Kashmiri (Arabic, India)"""
KS_ARAB_IN
+
+ """Shambala"""
KSB
+
+ """Shambala (Tanzania)"""
KSB_TZ
+
+ """Bafia"""
KSF
+
+ """Bafia (Cameroon)"""
KSF_CM
+
+ """Colognian"""
KSH
+
+ """Colognian (Germany)"""
KSH_DE
+
+ """Kurdish"""
KU
+
+ """Kurdish (Turkey)"""
KU_TR
+
+ """Cornish"""
KW
+
+ """Cornish (United Kingdom)"""
KW_GB
+
+ """Kyrgyz"""
KY
+
+ """Kyrgyz (Kyrgyzstan)"""
KY_KG
+
+ """Langi"""
LAG
+
+ """Langi (Tanzania)"""
LAG_TZ
+
+ """Luxembourgish"""
LB
+
+ """Luxembourgish (Luxembourg)"""
LB_LU
+
+ """Ganda"""
LG
+
+ """Ganda (Uganda)"""
LG_UG
+
+ """Lakota"""
LKT
+
+ """Lakota (United States)"""
LKT_US
+
+ """Lingala"""
LN
+
+ """Lingala (Angola)"""
LN_AO
+
+ """Lingala (Congo - Kinshasa)"""
LN_CD
+
+ """Lingala (Central African Republic)"""
LN_CF
+
+ """Lingala (Congo - Brazzaville)"""
LN_CG
+
+ """Lao"""
LO
+
+ """Lao (Laos)"""
LO_LA
+
+ """Northern Luri"""
LRC
+
+ """Northern Luri (Iraq)"""
LRC_IQ
+
+ """Northern Luri (Iran)"""
LRC_IR
+
+ """Lithuanian"""
LT
+
+ """Lithuanian (Lithuania)"""
LT_LT
+
+ """Luba-Katanga"""
LU
+
+ """Luba-Katanga (Congo - Kinshasa)"""
LU_CD
+
+ """Luo"""
LUO
+
+ """Luo (Kenya)"""
LUO_KE
+
+ """Luyia"""
LUY
+
+ """Luyia (Kenya)"""
LUY_KE
+
+ """Latvian"""
LV
+
+ """Latvian (Latvia)"""
LV_LV
+
+ """Maithili"""
MAI
+
+ """Maithili (India)"""
MAI_IN
+
+ """Masai"""
MAS
+
+ """Masai (Kenya)"""
MAS_KE
+
+ """Masai (Tanzania)"""
MAS_TZ
+
+ """Meru"""
MER
+
+ """Meru (Kenya)"""
MER_KE
+
+ """Morisyen"""
MFE
+
+ """Morisyen (Mauritius)"""
MFE_MU
+
+ """Malagasy"""
MG
+
+ """Malagasy (Madagascar)"""
MG_MG
+
+ """Makhuwa-Meetto"""
MGH
+
+ """Makhuwa-Meetto (Mozambique)"""
MGH_MZ
+
+ """Metaʼ"""
MGO
+
+ """Metaʼ (Cameroon)"""
MGO_CM
+
+ """Maori"""
MI
+
+ """Maori (New Zealand)"""
MI_NZ
+
+ """Macedonian"""
MK
+
+ """Macedonian (North Macedonia)"""
MK_MK
+
+ """Malayalam"""
ML
+
+ """Malayalam (India)"""
ML_IN
+
+ """Mongolian"""
MN
+
+ """Mongolian (Mongolia)"""
MN_MN
+
+ """Manipuri"""
MNI
+
+ """Manipuri (Bangla)"""
MNI_BENG
+
+ """Manipuri (Bangla, India)"""
MNI_BENG_IN
+
+ """Marathi"""
MR
+
+ """Marathi (India)"""
MR_IN
+
+ """Malay"""
MS
+
+ """Malay (Brunei)"""
MS_BN
+
+ """Malay (Indonesia)"""
MS_ID
+
+ """Malay (Malaysia)"""
MS_MY
+
+ """Malay (Singapore)"""
MS_SG
+
+ """Maltese"""
MT
+
+ """Maltese (Malta)"""
MT_MT
+
+ """Mundang"""
MUA
+
+ """Mundang (Cameroon)"""
MUA_CM
+
+ """Burmese"""
MY
+
+ """Burmese (Myanmar (Burma))"""
MY_MM
+
+ """Mazanderani"""
MZN
+
+ """Mazanderani (Iran)"""
MZN_IR
+
+ """Nama"""
NAQ
+
+ """Nama (Namibia)"""
NAQ_NA
+
+ """Norwegian Bokmål"""
NB
+
+ """Norwegian Bokmål (Norway)"""
NB_NO
+
+ """Norwegian Bokmål (Svalbard & Jan Mayen)"""
NB_SJ
+
+ """North Ndebele"""
ND
+
+ """North Ndebele (Zimbabwe)"""
ND_ZW
+
+ """Low German"""
NDS
+
+ """Low German (Germany)"""
NDS_DE
+
+ """Low German (Netherlands)"""
NDS_NL
+
+ """Nepali"""
NE
+
+ """Nepali (India)"""
NE_IN
+
+ """Nepali (Nepal)"""
NE_NP
+
+ """Dutch"""
NL
+
+ """Dutch (Aruba)"""
NL_AW
+
+ """Dutch (Belgium)"""
NL_BE
+
+ """Dutch (Caribbean Netherlands)"""
NL_BQ
+
+ """Dutch (Curaçao)"""
NL_CW
+
+ """Dutch (Netherlands)"""
NL_NL
+
+ """Dutch (Suriname)"""
NL_SR
+
+ """Dutch (Sint Maarten)"""
NL_SX
+
+ """Kwasio"""
NMG
+
+ """Kwasio (Cameroon)"""
NMG_CM
+
+ """Norwegian Nynorsk"""
NN
+
+ """Norwegian Nynorsk (Norway)"""
NN_NO
+
+ """Ngiemboon"""
NNH
+
+ """Ngiemboon (Cameroon)"""
NNH_CM
+
+ """Nuer"""
NUS
+
+ """Nuer (South Sudan)"""
NUS_SS
+
+ """Nyankole"""
NYN
+
+ """Nyankole (Uganda)"""
NYN_UG
+
+ """Oromo"""
OM
+
+ """Oromo (Ethiopia)"""
OM_ET
+
+ """Oromo (Kenya)"""
OM_KE
+
+ """Odia"""
OR
+
+ """Odia (India)"""
OR_IN
+
+ """Ossetic"""
OS
+
+ """Ossetic (Georgia)"""
OS_GE
+
+ """Ossetic (Russia)"""
OS_RU
+
+ """Punjabi"""
PA
+
+ """Punjabi (Arabic)"""
PA_ARAB
+
+ """Punjabi (Arabic, Pakistan)"""
PA_ARAB_PK
+
+ """Punjabi (Gurmukhi)"""
PA_GURU
+
+ """Punjabi (Gurmukhi, India)"""
PA_GURU_IN
+
+ """Nigerian Pidgin"""
PCM
+
+ """Nigerian Pidgin (Nigeria)"""
PCM_NG
+
+ """Polish"""
PL
+
+ """Polish (Poland)"""
PL_PL
+
+ """Prussian"""
PRG
+
+ """Pashto"""
PS
+
+ """Pashto (Afghanistan)"""
PS_AF
+
+ """Pashto (Pakistan)"""
PS_PK
+
+ """Portuguese"""
PT
+
+ """Portuguese (Angola)"""
PT_AO
+
+ """Portuguese (Brazil)"""
PT_BR
+
+ """Portuguese (Switzerland)"""
PT_CH
+
+ """Portuguese (Cape Verde)"""
PT_CV
+
+ """Portuguese (Equatorial Guinea)"""
PT_GQ
+
+ """Portuguese (Guinea-Bissau)"""
PT_GW
+
+ """Portuguese (Luxembourg)"""
PT_LU
+
+ """Portuguese (Macao SAR China)"""
PT_MO
+
+ """Portuguese (Mozambique)"""
PT_MZ
+
+ """Portuguese (Portugal)"""
PT_PT
+
+ """Portuguese (São Tomé & PrÃncipe)"""
PT_ST
+
+ """Portuguese (Timor-Leste)"""
PT_TL
+
+ """Quechua"""
QU
+
+ """Quechua (Bolivia)"""
QU_BO
+
+ """Quechua (Ecuador)"""
QU_EC
+
+ """Quechua (Peru)"""
QU_PE
+
+ """Romansh"""
RM
+
+ """Romansh (Switzerland)"""
RM_CH
+
+ """Rundi"""
RN
+
+ """Rundi (Burundi)"""
RN_BI
+
+ """Romanian"""
RO
+
+ """Romanian (Moldova)"""
RO_MD
+
+ """Romanian (Romania)"""
RO_RO
+
+ """Rombo"""
ROF
+
+ """Rombo (Tanzania)"""
ROF_TZ
+
+ """Russian"""
RU
+
+ """Russian (Belarus)"""
RU_BY
+
+ """Russian (Kyrgyzstan)"""
RU_KG
+
+ """Russian (Kazakhstan)"""
RU_KZ
+
+ """Russian (Moldova)"""
RU_MD
+
+ """Russian (Russia)"""
RU_RU
+
+ """Russian (Ukraine)"""
RU_UA
+
+ """Kinyarwanda"""
RW
+
+ """Kinyarwanda (Rwanda)"""
RW_RW
+
+ """Rwa"""
RWK
+
+ """Rwa (Tanzania)"""
RWK_TZ
+
+ """Sakha"""
SAH
+
+ """Sakha (Russia)"""
SAH_RU
+
+ """Samburu"""
SAQ
+
+ """Samburu (Kenya)"""
SAQ_KE
+
+ """Santali"""
SAT
+
+ """Santali (Ol Chiki)"""
SAT_OLCK
+
+ """Santali (Ol Chiki, India)"""
SAT_OLCK_IN
+
+ """Sangu"""
SBP
+
+ """Sangu (Tanzania)"""
SBP_TZ
+
+ """Sindhi"""
SD
+
+ """Sindhi (Arabic)"""
SD_ARAB
+
+ """Sindhi (Arabic, Pakistan)"""
SD_ARAB_PK
+
+ """Sindhi (Devanagari)"""
SD_DEVA
+
+ """Sindhi (Devanagari, India)"""
SD_DEVA_IN
+
+ """Northern Sami"""
SE
+
+ """Northern Sami (Finland)"""
SE_FI
+
+ """Northern Sami (Norway)"""
SE_NO
+
+ """Northern Sami (Sweden)"""
SE_SE
+
+ """Sena"""
SEH
+
+ """Sena (Mozambique)"""
SEH_MZ
+
+ """Koyraboro Senni"""
SES
+
+ """Koyraboro Senni (Mali)"""
SES_ML
+
+ """Sango"""
SG
+
+ """Sango (Central African Republic)"""
SG_CF
+
+ """Tachelhit"""
SHI
+
+ """Tachelhit (Latin)"""
SHI_LATN
+
+ """Tachelhit (Latin, Morocco)"""
SHI_LATN_MA
+
+ """Tachelhit (Tifinagh)"""
SHI_TFNG
+
+ """Tachelhit (Tifinagh, Morocco)"""
SHI_TFNG_MA
+
+ """Sinhala"""
SI
+
+ """Sinhala (Sri Lanka)"""
SI_LK
+
+ """Slovak"""
SK
+
+ """Slovak (Slovakia)"""
SK_SK
+
+ """Slovenian"""
SL
+
+ """Slovenian (Slovenia)"""
SL_SI
+
+ """Inari Sami"""
SMN
+
+ """Inari Sami (Finland)"""
SMN_FI
+
+ """Shona"""
SN
+
+ """Shona (Zimbabwe)"""
SN_ZW
+
+ """Somali"""
SO
+
+ """Somali (Djibouti)"""
SO_DJ
+
+ """Somali (Ethiopia)"""
SO_ET
+
+ """Somali (Kenya)"""
SO_KE
+
+ """Somali (Somalia)"""
SO_SO
+
+ """Albanian"""
SQ
+
+ """Albanian (Albania)"""
SQ_AL
+
+ """Albanian (North Macedonia)"""
SQ_MK
+
+ """Albanian (Kosovo)"""
SQ_XK
+
+ """Serbian"""
SR
+
+ """Serbian (Cyrillic)"""
SR_CYRL
+
+ """Serbian (Cyrillic, Bosnia & Herzegovina)"""
SR_CYRL_BA
+
+ """Serbian (Cyrillic, Montenegro)"""
SR_CYRL_ME
+
+ """Serbian (Cyrillic, Serbia)"""
SR_CYRL_RS
+
+ """Serbian (Cyrillic, Kosovo)"""
SR_CYRL_XK
+
+ """Serbian (Latin)"""
SR_LATN
+
+ """Serbian (Latin, Bosnia & Herzegovina)"""
SR_LATN_BA
+
+ """Serbian (Latin, Montenegro)"""
SR_LATN_ME
+
+ """Serbian (Latin, Serbia)"""
SR_LATN_RS
+
+ """Serbian (Latin, Kosovo)"""
SR_LATN_XK
+
+ """Sundanese"""
SU
+
+ """Sundanese (Latin)"""
SU_LATN
+
+ """Sundanese (Latin, Indonesia)"""
SU_LATN_ID
+
+ """Swedish"""
SV
+
+ """Swedish (Ã…land Islands)"""
SV_AX
+
+ """Swedish (Finland)"""
SV_FI
+
+ """Swedish (Sweden)"""
SV_SE
+
+ """Swahili"""
SW
+
+ """Swahili (Congo - Kinshasa)"""
SW_CD
+
+ """Swahili (Kenya)"""
SW_KE
+
+ """Swahili (Tanzania)"""
SW_TZ
+
+ """Swahili (Uganda)"""
SW_UG
+
+ """Tamil"""
TA
+
+ """Tamil (India)"""
TA_IN
+
+ """Tamil (Sri Lanka)"""
TA_LK
+
+ """Tamil (Malaysia)"""
TA_MY
+
+ """Tamil (Singapore)"""
TA_SG
+
+ """Telugu"""
TE
+
+ """Telugu (India)"""
TE_IN
+
+ """Teso"""
TEO
+
+ """Teso (Kenya)"""
TEO_KE
+
+ """Teso (Uganda)"""
TEO_UG
+
+ """Tajik"""
TG
+
+ """Tajik (Tajikistan)"""
TG_TJ
+
+ """Thai"""
TH
+
+ """Thai (Thailand)"""
TH_TH
+
+ """Tigrinya"""
TI
+
+ """Tigrinya (Eritrea)"""
TI_ER
+
+ """Tigrinya (Ethiopia)"""
TI_ET
+
+ """Turkmen"""
TK
+
+ """Turkmen (Turkmenistan)"""
TK_TM
+
+ """Tongan"""
TO
+
+ """Tongan (Tonga)"""
TO_TO
+
+ """Turkish"""
TR
+
+ """Turkish (Cyprus)"""
TR_CY
+
+ """Turkish (Turkey)"""
TR_TR
+
+ """Tatar"""
TT
+
+ """Tatar (Russia)"""
TT_RU
+
+ """Tasawaq"""
TWQ
+
+ """Tasawaq (Niger)"""
TWQ_NE
+
+ """Central Atlas Tamazight"""
TZM
+
+ """Central Atlas Tamazight (Morocco)"""
TZM_MA
+
+ """Uyghur"""
UG
+
+ """Uyghur (China)"""
UG_CN
+
+ """Ukrainian"""
UK
+
+ """Ukrainian (Ukraine)"""
UK_UA
+
+ """Urdu"""
UR
+
+ """Urdu (India)"""
UR_IN
+
+ """Urdu (Pakistan)"""
UR_PK
+
+ """Uzbek"""
UZ
+
+ """Uzbek (Arabic)"""
UZ_ARAB
+
+ """Uzbek (Arabic, Afghanistan)"""
UZ_ARAB_AF
+
+ """Uzbek (Cyrillic)"""
UZ_CYRL
+
+ """Uzbek (Cyrillic, Uzbekistan)"""
UZ_CYRL_UZ
+
+ """Uzbek (Latin)"""
UZ_LATN
+
+ """Uzbek (Latin, Uzbekistan)"""
UZ_LATN_UZ
+
+ """Vai"""
VAI
+
+ """Vai (Latin)"""
VAI_LATN
+
+ """Vai (Latin, Liberia)"""
VAI_LATN_LR
+
+ """Vai (Vai)"""
VAI_VAII
+
+ """Vai (Vai, Liberia)"""
VAI_VAII_LR
+
+ """Vietnamese"""
VI
+
+ """Vietnamese (Vietnam)"""
VI_VN
+
+ """Volapük"""
VO
+
+ """Vunjo"""
VUN
+
+ """Vunjo (Tanzania)"""
VUN_TZ
+
+ """Walser"""
WAE
+
+ """Walser (Switzerland)"""
WAE_CH
+
+ """Wolof"""
WO
+
+ """Wolof (Senegal)"""
WO_SN
+
+ """Xhosa"""
XH
+
+ """Xhosa (South Africa)"""
XH_ZA
+
+ """Soga"""
XOG
+
+ """Soga (Uganda)"""
XOG_UG
+
+ """Yangben"""
YAV
+
+ """Yangben (Cameroon)"""
YAV_CM
+
+ """Yiddish"""
YI
+
+ """Yoruba"""
YO
+
+ """Yoruba (Benin)"""
YO_BJ
+
+ """Yoruba (Nigeria)"""
YO_NG
+
+ """Cantonese"""
YUE
+
+ """Cantonese (Simplified)"""
YUE_HANS
+
+ """Cantonese (Simplified, China)"""
YUE_HANS_CN
+
+ """Cantonese (Traditional)"""
YUE_HANT
+
+ """Cantonese (Traditional, Hong Kong SAR China)"""
YUE_HANT_HK
+
+ """Standard Moroccan Tamazight"""
ZGH
+
+ """Standard Moroccan Tamazight (Morocco)"""
ZGH_MA
+
+ """Chinese"""
ZH
+
+ """Chinese (Simplified)"""
ZH_HANS
+
+ """Chinese (Simplified, China)"""
ZH_HANS_CN
+
+ """Chinese (Simplified, Hong Kong SAR China)"""
ZH_HANS_HK
+
+ """Chinese (Simplified, Macao SAR China)"""
ZH_HANS_MO
+
+ """Chinese (Simplified, Singapore)"""
ZH_HANS_SG
+
+ """Chinese (Traditional)"""
ZH_HANT
+
+ """Chinese (Traditional, Hong Kong SAR China)"""
ZH_HANT_HK
+
+ """Chinese (Traditional, Macao SAR China)"""
ZH_HANT_MO
+
+ """Chinese (Traditional, Taiwan)"""
ZH_HANT_TW
+
+ """Zulu"""
ZU
+
+ """Zulu (South Africa)"""
ZU_ZA
}
"""
Represents shipping method's original translatable fields and related translations.
"""
-type ShippingMethodTranslatableContent implements Node @doc(category: "Shipping") {
+type ShippingMethodTranslatableContent implements Node {
"""The ID of the shipping method translatable content."""
id: ID!
@@ -4816,7 +6792,7 @@ type ShippingMethodTranslatableContent implements Node @doc(category: "Shipping"
}
"""Represents shipping method channel listing."""
-type ShippingMethodChannelListing implements Node @doc(category: "Shipping") {
+type ShippingMethodChannelListing implements Node {
"""The ID of shipping method channel listing."""
id: ID!
@@ -4833,9 +6809,46 @@ type ShippingMethodChannelListing implements Node @doc(category: "Shipping") {
price: Money
}
-"""Represents channel."""
-type Channel implements Node & ObjectWithMetadata @doc(category: "Channels") {
- """The ID of the channel."""
+"""Represents shipping method postal code rule."""
+type ShippingMethodPostalCodeRule implements Node {
+ """The ID of the object."""
+ id: ID!
+
+ """Start address range."""
+ start: String
+
+ """End address range."""
+ end: String
+
+ """Inclusion type of the postal code rule."""
+ inclusionType: PostalCodeRuleInclusionTypeEnum
+}
+
+enum PostalCodeRuleInclusionTypeEnum {
+ INCLUDE
+ EXCLUDE
+}
+
+type ProductCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [ProductCountableEdge!]!
+
+ """A total count of items in the collection."""
+ totalCount: Int
+}
+
+type ProductCountableEdge {
+ """The item at the end of the edge."""
+ node: Product!
+
+ """A cursor for use in pagination."""
+ cursor: String!
+}
+
+"""Represents an individual item for sale in the storefront."""
+type Product implements Node & ObjectWithMetadata & ObjectWithAttributes {
+ """The ID of the product."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -4868,368 +6881,275 @@ type Channel implements Node & ObjectWithMetadata @doc(category: "Channels") {
"""
metafields(keys: [String!]): Metadata
- """Slug of the channel."""
- slug: String!
+ """
+ Get a single attribute attached to product by attribute slug.
+
+ Added in Saleor 3.22.
+ """
+ assignedAttribute(
+ """Slug of the attribute"""
+ slug: String!
+ ): AssignedAttribute
"""
- Name of the channel.
+ List of attributes assigned to this product.
- Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ Added in Saleor 3.22.
"""
+ assignedAttributes(
+ """Maximum number of attributes to return. Default is 100."""
+ limit: PositiveInt = 100
+ ): [AssignedAttribute!]!
+
+ """SEO title of the product."""
+ seoTitle: String
+
+ """SEO description of the product."""
+ seoDescription: String
+
+ """SEO description of the product."""
name: String!
"""
- Whether the channel is active.
+ Description of the product.
- Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ Rich text format. For reference see https://editorjs.io/
"""
- isActive: Boolean!
+ description: JSONString
+
+ """Type of the product."""
+ productType: ProductType!
+
+ """Slug of the product."""
+ slug: String!
+ category: Category
+
+ """The date and time when the product was created."""
+ created: DateTime!
+
+ """The date and time when the product was last updated."""
+ updatedAt: DateTime!
+ chargeTaxes: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration` field to determine whether tax collection is enabled.")
+
+ """Weight of the product."""
+ weight: Weight
+
+ """Default variant of the product."""
+ defaultVariant: ProductVariant
+
+ """Rating of the product."""
+ rating: Float
"""
- A currency that is assigned to the channel.
-
- Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ Channel given to retrieve this product. Also used by federation gateway to resolve this object in a federated query.
"""
- currencyCode: String!
+ channel: String
"""
- Whether a channel has associated orders.
+ Description of the product.
- Requires one of the following permissions: MANAGE_CHANNELS.
+ Rich text format. For reference see https://editorjs.io/
"""
- hasOrders: Boolean!
+ descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.")
+
+ """Thumbnail of the product."""
+ 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.
+ """
+ format: ThumbnailFormatEnum
+ ): Image
"""
- 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.
-
- Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ Lists the storefront product's pricing, the current price and discounts, only meant for displaying.
"""
- defaultCountry: CountryDisplay!
+ 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
"""
- List of warehouses assigned to this channel.
-
- Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ Whether the product is in stock, set as available for purchase in the given channel, and published.
"""
- warehouses: [Warehouse!]!
+ 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
- """List of shippable countries for the channel."""
- countries: [CountryDisplay!]
+ """A type of tax. Assigned by enabled tax gateway"""
+ taxType: TaxType @deprecated(reason: "Use `taxClass` field instead.")
- """Shipping methods that are available for the channel."""
- availableShippingMethodsPerCountry(countries: [CountryCode!]): [ShippingMethodsPerCountry!]
+ """Get a single attribute attached to product by attribute slug."""
+ attribute(
+ """Slug of the attribute"""
+ slug: String!
+ ): SelectedAttribute @deprecated(reason: "Use the `assignedAttribute` field instead.")
+
+ """List of attributes assigned to this product."""
+ attributes: [SelectedAttribute!]! @deprecated(reason: "Use the `assignedAttributes` field instead.")
"""
- Define the stock setting for this channel.
+ List of availability in channels for the product.
- Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ Requires one of the following permissions: MANAGE_PRODUCTS.
"""
- stockSettings: StockSettings!
+ 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: "Use the `mediaById` field instead.")
+
+ """Get a single variant by SKU or ID."""
+ variant(
+ """ID of the variant."""
+ id: ID
+
+ """SKU of the variant."""
+ sku: String
+ ): ProductVariant @deprecated(reason: "Use top-level `variant` query.")
"""
- Channel-specific order settings.
-
- Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_ORDERS.
+ List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
- orderSettings: OrderSettings!
+ variants: [ProductVariant!] @deprecated(reason: "Use `productVariants` field instead.")
"""
- Channel-specific checkout settings.
+ List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
- Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_CHECKOUTS.
+ Added in Saleor 3.21.
"""
- checkoutSettings: CheckoutSettings!
+ productVariants(
+ """
+ Filtering options for product variant.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: ProductVariantFilterInput
+
+ """Where filtering options for product variants."""
+ where: ProductVariantWhereInput
+
+ """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
+
+ """List of media for the product."""
+ media(
+ """Sort media."""
+ sortBy: MediaSortingInput
+ ): [ProductMedia!]
+
+ """List of images for the product."""
+ images: [ProductImage!] @deprecated(reason: "Use the `media` field instead.")
"""
- Channel-specific payment settings.
-
- Requires one of the following permissions: MANAGE_CHANNELS, HANDLE_PAYMENTS.
+ List of collections for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
- paymentSettings: PaymentSettings!
+ 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: "Use the `availableForPurchaseAt` field to fetch the available for purchase date.")
+
+ """Date when product is available for purchase."""
+ availableForPurchaseAt: DateTime
"""
- Channel specific tax configuration.
-
- Added in Saleor 3.20.
+ Refers to a state that can be set by admins to control whether a product is available for purchase in storefronts. This does not guarantee the availability of stock. When set to `False`, this product is still visible to customers, but it cannot be purchased.
+ """
+ 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.
"""
- taxConfiguration: TaxConfiguration!
+ taxClass: TaxClass
+
+ """External ID of this product."""
+ externalReference: String
}
-"""List of shipping methods available for the country."""
-type ShippingMethodsPerCountry @doc(category: "Shipping") {
- """The country code."""
- countryCode: CountryCode!
+"""
+An object with attributes.
- """List of available shipping methods."""
- shippingMethods: [ShippingMethod!]
+Added in Saleor 3.22.
+"""
+interface ObjectWithAttributes {
+ """
+ Get a single attribute attached to the object by attribute slug.
+
+ Added in Saleor 3.22.
+ """
+ assignedAttribute(
+ """Slug of the attribute"""
+ slug: String!
+ ): AssignedAttribute
+
+ """
+ List of attributes assigned to the object.
+
+ Added in Saleor 3.22.
+ """
+ assignedAttributes(
+ """Maximum number of attributes to return. Default is 100."""
+ limit: PositiveInt = 100
+ ): [AssignedAttribute!]!
}
"""
-Represents country codes defined by the ISO 3166-1 alpha-2 standard.
+Represents an attribute assigned to an object.
-The `EU` value is DEPRECATED and will be removed in Saleor 3.21.
+Added in Saleor 3.22.
"""
-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
- XK
- 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
+interface AssignedAttribute {
+ """Attribute assigned to an object."""
+ attribute: Attribute!
}
"""
-Shipping methods that can be used as means of shipping for orders and checkouts.
+Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.
"""
-type ShippingMethod implements Node & ObjectWithMetadata @doc(category: "Shipping") {
- """Unique ID of ShippingMethod available for Order."""
+type Attribute implements Node & ObjectWithMetadata {
+ """The ID of the attribute."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -5262,249 +7182,201 @@ type ShippingMethod implements Node & ObjectWithMetadata @doc(category: "Shippin
"""
metafields(keys: [String!]): Metadata
- """Type of the shipping method."""
- type: ShippingMethodTypeEnum @deprecated
+ """The input type to use for entering attribute values in the dashboard."""
+ inputType: AttributeInputTypeEnum
- """Shipping method name."""
- name: String!
+ """The entity type which can be used as a reference."""
+ entityType: AttributeEntityTypeEnum
"""
- Shipping method description.
+ The reference types (product or page type) that are used to narrow down the choices of reference objects.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.22.
"""
- description: JSONString
-
- """Maximum delivery days for this shipping method."""
- maximumDeliveryDays: Int
+ referenceTypes(
+ """
+ Maximum number of objects to return. Value must be greater than 0. Default is 100.
+ """
+ limit: PositiveInt = 100
+ ): [ReferenceType!]
- """Minimum delivery days for this shipping method."""
- minimumDeliveryDays: Int
+ """Name of an attribute displayed in the interface."""
+ name: String
- """Maximum order weight for this shipping method."""
- maximumOrderWeight: Weight @deprecated
+ """Internal representation of an attribute name."""
+ slug: String
- """Minimum order weight for this shipping method."""
- minimumOrderWeight: Weight @deprecated
+ """The attribute type."""
+ type: AttributeTypeEnum
- """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 unit of attribute values."""
+ unit: MeasurementUnitsEnum
- """The price of selected shipping method."""
- price: Money!
+ """
+ A list of predefined attribute choices available for selection. Available only for attributes with predefined choices.
+ """
+ choices(
+ """Sort attribute choices."""
+ sortBy: AttributeChoicesSortingInput
- """Maximum order price for this shipping method."""
- maximumOrderPrice: Money
+ """
+ Filtering options for attribute choices.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: AttributeValueFilterInput
- """Minimal order price for this shipping method."""
- minimumOrderPrice: Money
+ """
+ Where filtering options for attribute choices.
+
+ Added in Saleor 3.22.
+ """
+ where: AttributeValueWhereInput
- """Describes if this shipping method is active and can be selected."""
- active: Boolean!
+ """
+ Search attribute choices.
+
+ Added in Saleor 3.22.
+ """
+ search: String
- """Message connected to this shipping method."""
- message: String
-}
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
-"""Represents weight value in a specific weight unit."""
-type Weight {
- """Weight unit."""
- unit: WeightUnitsEnum!
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """Weight value. Returns a value with maximal three decimal places"""
- value: Float!
-}
+ """
+ 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
-enum WeightUnitsEnum {
- G
- LB
- OZ
- KG
- TONNE
-}
+ """
+ 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
-"""Represents the channel stock settings."""
-type StockSettings @doc(category: "Products") {
"""
- Allocation strategy defines the preference of warehouses for allocations and reservations.
+ 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.
"""
- 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
-}
+ valueRequired: Boolean!
-"""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.
+ 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.
"""
- automaticallyConfirmAllNewOrders: Boolean!
+ visibleInStorefront: Boolean!
"""
- When enabled, all non-shippable gift card orders will be fulfilled automatically.
+ 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.
"""
- automaticallyFulfillNonShippableGiftCard: Boolean!
+ filterableInStorefront: Boolean! @deprecated
"""
- Expiration time in minutes. Default null - means do not expire any orders.
+ 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.
"""
- expireOrdersAfter: Minute
+ filterableInDashboard: Boolean!
"""
- 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.
+ 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.
"""
- markAsPaidStrategy: MarkAsPaidStrategyEnum!
-
- """The time in days after expired orders will be deleted."""
- deleteExpiredOrdersAfter: Day!
+ availableInGrid: Boolean! @deprecated
"""
- Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation.
+ 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.
"""
- allowUnpaidOrders: Boolean!
+ storefrontSearchPosition: Int! @deprecated
- """
- Determine if voucher applied on draft order should be count toward voucher usage.
-
- Added in Saleor 3.18.
-
- Note: this API is currently in Feature Preview and can be subject to changes at later point.
- """
- includeDraftOrderInVoucherUsage: Boolean!
+ """Returns translated attribute fields for the given language code."""
+ translation(
+ """A language code to return the translation for attribute."""
+ languageCode: LanguageCodeEnum!
+ ): AttributeTranslation
- """
- Time in hours after which the draft order line price will be refreshed.
-
- Added in Saleor 3.21.
-
- Note: this API is currently in Feature Preview and can be subject to changes at later point.
- """
- draftOrderLinePriceFreezePeriod: Hour
+ """Flag indicating that attribute has predefined choices."""
+ withChoices: Boolean!
"""
- This flag only affects orders created from checkout and applies specifically to vouchers of the types: `SPECIFIC_PRODUCT` and `ENTIRE_ORDER` with `applyOncePerOrder` enabled.
- - When legacy propagation is enabled, discounts from these vouchers are represented as `OrderDiscount` objects, attached to the order and returned in the `Order.discounts` field. Additionally, percentage-based vouchers are converted to fixed-value discounts.
- - When legacy propagation is disabled, discounts are represented as `OrderLineDiscount` objects, attached to individual lines and returned in the `OrderLine.discounts` field. In this case, percentage-based vouchers retain their original type.
- In future releases, `OrderLineDiscount` will become the default behavior, and this flag will be deprecated and removed.
-
- Added in Saleor 3.21.
+ A list of product types that use this attribute as a product attribute.
"""
- useLegacyLineDiscountPropagation: Boolean!
-}
-
-"""
-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
-}
+ productTypes(
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
-"""The `Day` scalar type represents number of days by integer value."""
-scalar Day
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
-"""The `Hour` scalar type represents number of hours by integer value."""
-scalar Hour
+ """
+ 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
-"""Represents the channel-specific checkout settings."""
-type CheckoutSettings {
- """
- Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
- """
- useLegacyErrorFlow: Boolean!
+ """
+ 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!
"""
- Default `false`. Determines if the paid checkouts should be automatically completed. This setting applies only to checkouts where payment was processed through transactions.When enabled, the checkout will be automatically completed once the checkout `charge_status` reaches `FULL`. This occurs when the total sum of charged and authorized transaction amounts equals or exceeds the checkout's total amount.
-
- Added in Saleor 3.20.
+ A list of product types that use this attribute as a product variant attribute.
"""
- automaticallyCompleteFullyPaidCheckouts: Boolean!
+ productVariantTypes(
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """
- The time in minutes to wait after a checkout is fully paid before automatically completing it.
-
- Added in Saleor 3.22.
- """
- automaticCompletionDelay: Minute
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """
- The date time defines the earliest checkout creation date on which fully paid checkouts can begin to be automatically completed.
-
- Added in Saleor 3.22.
- """
- automaticCompletionCutOffDate: DateTime
-}
+ """
+ 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
-"""Represents the channel-specific payment settings."""
-type PaymentSettings {
- """
- 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.
- """
- defaultTransactionFlowStrategy: TransactionFlowStrategyEnum!
+ """
+ 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!
- """
- Determine if the funds for expired checkouts should be released automatically.
-
- Added in Saleor 3.20.
- """
- releaseFundsForExpiredCheckouts: Boolean
+ """External ID of this attribute."""
+ externalReference: String
+}
- """
- The time in hours after which funds for expired checkouts will be released.
-
- Added in Saleor 3.20.
- """
- checkoutTtlBeforeReleasingFunds: Hour
+enum AttributeInputTypeEnum {
+ DROPDOWN
+ MULTISELECT
+ FILE
+ REFERENCE
+ SINGLE_REFERENCE
+ NUMERIC
+ RICH_TEXT
+ PLAIN_TEXT
+ SWATCH
+ BOOLEAN
+ DATE
+ DATE_TIME
+}
- """
- Specifies the earliest date on which funds for expired checkouts can begin to be released. Expired checkouts dated before this cut-off will not have their funds released. Additionally, no funds will be released for checkouts that are more than one year old, regardless of the cut-off date.
-
- Added in Saleor 3.20.
- """
- checkoutReleaseFundsCutOffDate: DateTime
+enum AttributeEntityTypeEnum {
+ PAGE
+ PRODUCT
+ PRODUCT_VARIANT
+ CATEGORY
+ COLLECTION
}
"""
-Determine the transaction flow strategy.
-
- AUTHORIZATION - the processed transaction should be only authorized
- CHARGE - the processed transaction should be charged.
+The reference types (product or page type) that are used to narrow down the choices of reference objects.
+ProductType applicable for reference attribute with `PRODUCT` or `PRODUCT_VARIANT` entity type.
+PageType applicable for reference attribute with `PAGE` entity type.
"""
-enum TransactionFlowStrategyEnum @doc(category: "Payments") {
- AUTHORIZATION
- CHARGE
-}
+union ReferenceType = ProductType | PageType
-"""Channel-specific tax configuration."""
-type TaxConfiguration implements Node & ObjectWithMetadata @doc(category: "Taxes") {
- """The ID of the object."""
+"""
+Represents a type of product. It defines what attributes are available to products of this type.
+"""
+type ProductType implements Node & ObjectWithMetadata {
+ """The ID of the product type."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -5537,119 +7409,149 @@ type TaxConfiguration implements Node & ObjectWithMetadata @doc(category: "Taxes
"""
metafields(keys: [String!]): Metadata
- """A channel to which the tax configuration applies to."""
- channel: Channel!
+ """Name of the product type."""
+ name: String!
- """Determines whether taxes are charged in the given channel."""
- chargeTaxes: Boolean!
+ """Slug of the product type."""
+ slug: String!
- """
- 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
+ """Whether the product type has variants."""
+ hasVariants: Boolean!
- """Determines whether displayed prices should include taxes."""
- displayGrossPrices: Boolean!
+ """Whether shipping is required for this product type."""
+ isShippingRequired: Boolean!
- """Determines whether prices are entered with the tax included."""
- pricesEnteredWithTax: Boolean!
+ """Whether the product type is digital."""
+ isDigital: Boolean!
- """List of country-specific exceptions in tax configuration."""
- countries: [TaxConfigurationPerCountry!]!
+ """Weight of the product type."""
+ weight: Weight
- """
- The tax app `App.identifier` that will be used to calculate the taxes for the given channel. Empty value for `TAX_APP` set as `taxCalculationStrategy` means that Saleor will iterate over all installed tax apps. If multiple tax apps exist with provided tax app id use the `App` with newest `created` date. Will become mandatory in 4.0 for `TAX_APP` `taxCalculationStrategy`.
-
- Added in Saleor 3.19.
- """
- taxAppId: String
+ """The product type kind."""
+ kind: ProductTypeKindEnum!
- """
- Determines whether to use weighted tax for shipping. When set to true, the tax rate for shipping will be calculated based on the weighted average of tax rates from the order or checkout lines.
-
- Added in Saleor 3.21.
- """
- useWeightedTaxForShipping: Boolean
-}
+ """List of products of this type."""
+ products(
+ """Slug of a channel for which the data should be returned."""
+ channel: String
-enum TaxCalculationStrategy @doc(category: "Taxes") {
- FLAT_RATES
- TAX_APP
-}
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
-"""Country-specific exceptions of a channel's tax configuration."""
-type TaxConfigurationPerCountry @doc(category: "Taxes") {
- """Country in which this configuration applies."""
- country: CountryDisplay!
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """Determines whether taxes are charged in this country."""
- chargeTaxes: Boolean!
+ """
+ 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
- """
- 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
+ """
+ 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: "Use the top-level `products` query with the `productTypes` filter.")
+
+ """A type of tax. Assigned by enabled tax gateway"""
+ taxType: TaxType @deprecated(reason: "Use `taxClass` field instead.")
"""
- Determines whether displayed prices should include taxes for this country.
+ 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.
"""
- displayGrossPrices: Boolean!
+ taxClass: TaxClass
+
+ """Variant attributes of that product type."""
+ variantAttributes(
+ """Define scope of returned attributes."""
+ variantSelection: VariantAttributeScope
+ ): [Attribute!] @deprecated(reason: "Use `assignedVariantAttributes` instead.")
"""
- The tax app `App.identifier` that will be used to calculate the taxes for the given channel and country. If not provided, use the value from the channel's tax configuration.
-
- Added in Saleor 3.19.
+ Variant attributes of that product type with attached variant selection.
"""
- taxAppId: String
+ assignedVariantAttributes(
+ """Define scope of returned attributes."""
+ variantSelection: VariantAttributeScope
+ ): [AssignedVariantAttribute!]
+
+ """Product attributes of that product type."""
+ productAttributes: [Attribute!]
"""
- Determines whether to use weighted tax for shipping. When set to true, the tax rate for shipping will be calculated based on the weighted average of tax rates from the order or checkout lines.
+ List of attributes which can be assigned to this product type.
- Added in Saleor 3.21.
+ Requires one of the following permissions: MANAGE_PRODUCTS.
"""
- useWeightedTaxForShipping: Boolean
-}
+ availableAttributes(
+ """
+ Filtering options for attributes of this product type.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: AttributeFilterInput
-"""Represents shipping method postal code rule."""
-type ShippingMethodPostalCodeRule implements Node @doc(category: "Shipping") {
- """The ID of the object."""
- id: ID!
+ """Where filtering options for attributes of this product type."""
+ where: AttributeWhereInput
- """Start address range."""
- start: String
+ """Search attributes."""
+ search: String
- """End address range."""
- end: String
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """Inclusion type of the postal code rule."""
- inclusionType: PostalCodeRuleInclusionTypeEnum
+ """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
}
-enum PostalCodeRuleInclusionTypeEnum @doc(category: "Shipping") {
- INCLUDE
- EXCLUDE
+"""Represents weight value in a specific weight unit."""
+type Weight {
+ """Weight unit."""
+ unit: WeightUnitsEnum!
+
+ """Weight value. Returns a value with maximal three decimal places"""
+ value: Float!
}
-type ProductCountableConnection @doc(category: "Products") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [ProductCountableEdge!]!
+enum WeightUnitsEnum {
+ G
+ LB
+ OZ
+ KG
+ TONNE
+}
- """A total count of items in the collection."""
- totalCount: Int
+enum ProductTypeKindEnum {
+ NORMAL
+ GIFT_CARD
}
-type ProductCountableEdge @doc(category: "Products") {
- """The item at the end of the edge."""
- node: Product!
+"""Representation of tax types fetched from tax gateway."""
+type TaxType {
+ """Description of the tax type."""
+ description: String
- """A cursor for use in pagination."""
- cursor: String!
+ """External tax code used to identify given tax group."""
+ taxCode: String
}
-"""Represents an individual item for sale in the storefront."""
-type Product implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(category: "Products") {
- """The ID of the product."""
+"""
+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.
+"""
+type TaxClass implements Node & ObjectWithMetadata {
+ """The ID of the object."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -5682,271 +7584,206 @@ type Product implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(ca
"""
metafields(keys: [String!]): Metadata
- """
- Get a single attribute attached to product by attribute slug.
-
- Added in Saleor 3.22.
- """
- assignedAttribute(
- """Slug of the attribute"""
- slug: String!
- ): AssignedAttribute
-
- """
- List of attributes assigned to this product.
-
- Added in Saleor 3.22.
- """
- assignedAttributes(
- """Maximum number of attributes to return. Default is 100."""
- limit: PositiveInt = 100
- ): [AssignedAttribute!]!
-
- """SEO title of the product."""
- seoTitle: String
-
- """SEO description of the product."""
- seoDescription: String
-
- """SEO description of the product."""
+ """Name of the tax class."""
name: String!
- """
- Description of the product.
-
- Rich text format. For reference see https://editorjs.io/
- """
- description: JSONString
-
- """Type of the product."""
- productType: ProductType!
-
- """Slug of the product."""
- slug: String!
- category: Category
-
- """The date and time when the product was created."""
- created: DateTime!
-
- """The date and time when the product was last updated."""
- updatedAt: DateTime!
- chargeTaxes: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration` field to determine whether tax collection is enabled.")
-
- """Weight of the product."""
- weight: Weight
-
- """Default variant of the product."""
- defaultVariant: ProductVariant
-
- """Rating of the product."""
- 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: "Use the `description` field instead.")
-
- """Thumbnail of the product."""
- 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.
- """
- format: ThumbnailFormatEnum = ORIGINAL
- ): Image
+ """Country-specific tax rates for this tax class."""
+ countries: [TaxClassCountryRate!]!
+}
- """
- 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
+"""
+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.
+"""
+type TaxClassCountryRate {
+ """Country in which this tax rate applies."""
+ country: CountryDisplay!
- """
- Whether the product is in stock, set as available for purchase in the given channel, and published.
- """
- 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
+ """Tax rate value."""
+ rate: Float!
- """A type of tax. Assigned by enabled tax gateway"""
- taxType: TaxType @deprecated(reason: "Use `taxClass` field instead.")
+ """Related tax class."""
+ taxClass: TaxClass
+}
- """Get a single attribute attached to product by attribute slug."""
- attribute(
- """Slug of the attribute"""
- slug: String!
- ): SelectedAttribute @deprecated(reason: "Use the `assignedAttribute` field instead.")
+enum VariantAttributeScope {
+ ALL
+ VARIANT_SELECTION
+ NOT_VARIANT_SELECTION
+}
- """List of attributes assigned to this product."""
- attributes: [SelectedAttribute!]! @deprecated(reason: "Use the `assignedAttributes` field instead.")
+"""
+Represents assigned attribute to variant with variant selection attached.
+"""
+type AssignedVariantAttribute {
+ """Attribute assigned to variant."""
+ attribute: Attribute!
"""
- List of availability in channels for the product.
-
- Requires one of the following permissions: MANAGE_PRODUCTS.
+ Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric']
"""
- channelListings: [ProductChannelListing!]
+ variantSelection: Boolean!
+}
- """Get a single product media by ID."""
- mediaById(
- """ID of a product media."""
- id: ID!
- ): ProductMedia
+type AttributeCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [AttributeCountableEdge!]!
- """Get a single product image by ID."""
- imageById(
- """ID of a product image."""
- id: ID!
- ): ProductImage @deprecated(reason: "Use the `mediaById` field instead.")
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Get a single variant by SKU or ID."""
- variant(
- """ID of the variant."""
- id: ID
+type AttributeCountableEdge {
+ """The item at the end of the edge."""
+ node: Attribute!
- """SKU of the variant."""
- sku: String
- ): ProductVariant @deprecated(reason: "Use top-level `variant` query.")
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """
- List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
- """
- variants: [ProductVariant!] @deprecated(reason: "Use `productVariants` field instead.")
+input AttributeFilterInput {
+ valueRequired: Boolean
+ isVariantOnly: Boolean
+ visibleInStorefront: Boolean
+ filterableInStorefront: Boolean
+ filterableInDashboard: Boolean
+ availableInGrid: Boolean
+ metadata: [MetadataFilter!]
+ search: String
+ ids: [ID!]
+ type: AttributeTypeEnum
+ inCollection: ID
+ inCategory: ID
+ slugs: [String!]
"""
- List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
+ Specifies the channel by which the data should be filtered.
- Added in Saleor 3.21.
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
"""
- productVariants(
- """Filtering options for product variant."""
- filter: ProductVariantFilterInput @deprecated(reason: "Use `where` filter instead.")
-
- """Where filtering options for product variants."""
- where: ProductVariantWhereInput
+ channel: String
+}
- """Sort products variants."""
- sortBy: ProductVariantSortingInput
+input MetadataFilter {
+ """Key of a metadata item."""
+ key: String!
- """Return the elements in the list that come before the specified cursor."""
- before: String
+ """Value of a metadata item."""
+ value: String
+}
- """Return the elements in the list that come after the specified cursor."""
- after: String
+enum AttributeTypeEnum {
+ PRODUCT_TYPE
+ PAGE_TYPE
+}
- """
- 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
+"""Where filtering options."""
+input AttributeWhereInput {
+ metadata: [MetadataFilter!]
+ ids: [ID!]
+ name: StringFilterInput
+ slug: StringFilterInput
+ withChoices: Boolean
+ inputType: AttributeInputTypeEnumFilterInput
+ entityType: AttributeEntityTypeEnumFilterInput
+ type: AttributeTypeEnumFilterInput
+ unit: MeasurementUnitsEnumFilterInput
+ inCollection: ID
+ inCategory: ID
+ valueRequired: Boolean
+ visibleInStorefront: Boolean
+ filterableInDashboard: Boolean
- """
- 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 conditions that must be met."""
+ AND: [AttributeWhereInput!]
- """List of media for the product."""
- media(
- """Sort media."""
- sortBy: MediaSortingInput
- ): [ProductMedia!]
+ """A list of conditions of which at least one must be met."""
+ OR: [AttributeWhereInput!]
+}
- """List of images for the product."""
- images: [ProductImage!] @deprecated(reason: "Use the `media` field instead.")
+"""Define the filtering options for string fields."""
+input StringFilterInput {
+ """The value equal to."""
+ eq: String
- """
- List of collections for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
- """
- collections: [Collection!]
+ """The value included in."""
+ oneOf: [String!]
+}
- """Returns translated product fields for the given language code."""
- translation(
- """A language code to return the translation for product."""
- languageCode: LanguageCodeEnum!
- ): ProductTranslation
+input AttributeInputTypeEnumFilterInput {
+ """The value equal to."""
+ eq: AttributeInputTypeEnum
- """Date when product is available for purchase."""
- availableForPurchase: Date @deprecated(reason: "Use the `availableForPurchaseAt` field to fetch the available for purchase date.")
+ """The value included in."""
+ oneOf: [AttributeInputTypeEnum!]
+}
- """Date when product is available for purchase."""
- availableForPurchaseAt: DateTime
+input AttributeEntityTypeEnumFilterInput {
+ """The value equal to."""
+ eq: AttributeEntityTypeEnum
- """
- Refers to a state that can be set by admins to control whether a product is available for purchase in storefronts. This does not guarantee the availability of stock. When set to `False`, this product is still visible to customers, but it cannot be purchased.
- """
- isAvailableForPurchase: Boolean
+ """The value included in."""
+ oneOf: [AttributeEntityTypeEnum!]
+}
- """
- 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
+input AttributeTypeEnumFilterInput {
+ """The value equal to."""
+ eq: AttributeTypeEnum
- """External ID of this product."""
- externalReference: String
+ """The value included in."""
+ oneOf: [AttributeTypeEnum!]
}
-"""
-An object with attributes.
-
-Added in Saleor 3.22.
-"""
-interface ObjectWithAttributes @doc(category: "Attributes") {
- """
- Get a single attribute attached to the object by attribute slug.
-
- Added in Saleor 3.22.
- """
- assignedAttribute(
- """Slug of the attribute"""
- slug: String!
- ): AssignedAttribute @doc(category: "Attributes")
+input MeasurementUnitsEnumFilterInput {
+ """The value equal to."""
+ eq: MeasurementUnitsEnum
- """
- List of attributes assigned to the object.
-
- Added in Saleor 3.22.
- """
- assignedAttributes(
- """Maximum number of attributes to return. Default is 100."""
- limit: PositiveInt = 100
- ): [AssignedAttribute!]!
+ """The value included in."""
+ oneOf: [MeasurementUnitsEnum!]
}
-"""
-Represents an attribute assigned to an object.
-
-Added in Saleor 3.22.
-"""
-interface AssignedAttribute @doc(category: "Attributes") {
- """Attribute assigned to an object."""
- attribute: Attribute!
+enum MeasurementUnitsEnum {
+ MM
+ CM
+ DM
+ M
+ KM
+ FT
+ YD
+ INCH
+ SQ_MM
+ SQ_CM
+ SQ_DM
+ 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
}
"""
-Custom attribute of a product. Attributes can be assigned to products and variants at the product type level.
+Represents a type of page. It defines what attributes are available to pages of this type.
"""
-type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes") {
- """The ID of the attribute."""
+type PageType implements Node & ObjectWithMetadata {
+ """ID of the page type."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -5979,58 +7816,32 @@ type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes")
"""
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
-
- """
- The reference types (product or page type) that are used to narrow down the choices of reference objects.
-
- Added in Saleor 3.22.
- """
- referenceTypes(
- """
- Maximum number of objects to return. Value must be greater than 0. Default is 100.
- """
- limit: PositiveInt = 100
- ): [ReferenceType!]
-
- """Name of an attribute displayed in the interface."""
- name: String
-
- """Internal representation of an attribute name."""
- slug: String
+ """Name of the page type."""
+ name: String!
- """The attribute type."""
- type: AttributeTypeEnum
+ """Slug of the page type."""
+ slug: String!
- """The unit of attribute values."""
- unit: MeasurementUnitsEnum
+ """Page attributes of that page type."""
+ attributes: [Attribute!]
"""
- A list of predefined attribute choices available for selection. Available only for attributes with predefined choices.
+ Attributes that can be assigned to the page type.
+
+ Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
- choices(
- """Sort attribute choices."""
- sortBy: AttributeChoicesSortingInput
-
- """Filtering options for attribute choices."""
- filter: AttributeValueFilterInput @deprecated(reason: "Use `where` filter instead.")
-
+ availableAttributes(
"""
- Where filtering options for attribute choices.
+ Filtering options for attributes.
- Added in Saleor 3.22.
+ DEPRECATED: this field will be removed. Use `where` filter instead.
"""
- where: AttributeValueWhereInput
+ filter: AttributeFilterInput
- """
- Search attribute choices.
-
- Added in Saleor 3.22.
- """
+ """Where filtering options for attributes."""
+ where: AttributeWhereInput
+
+ """Search attributes."""
search: String
"""Return the elements in the list that come before the specified cursor."""
@@ -6048,37 +7859,169 @@ type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes")
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
+ ): AttributeCountableConnection
"""
- 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.
+ Whether page type has pages assigned.
+
+ Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
- valueRequired: Boolean!
+ hasPages: Boolean
+}
+
+"""
+Positive Integer scalar implementation.
+
+Should be used in places where value must be positive (greater than 0).
+"""
+scalar PositiveInt
+
+type AttributeValueCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [AttributeValueCountableEdge!]!
+
+ """A total count of items in the collection."""
+ totalCount: Int
+}
+
+type AttributeValueCountableEdge {
+ """The item at the end of the edge."""
+ node: AttributeValue!
+
+ """A cursor for use in pagination."""
+ cursor: String!
+}
+
+"""Represents a value of an attribute."""
+type AttributeValue implements Node {
+ """The ID of the attribute value."""
+ id: ID!
+
+ """Name of a value displayed in the interface."""
+ name: String
+
+ """Internal representation of a value (unique per attribute)."""
+ slug: String
"""
- 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.
+ Represent value of the attribute value (e.g. color values for swatch attributes).
"""
- visibleInStorefront: Boolean!
+ 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 referenced object."""
+ reference: ID
+
+ """Represents file URL and content type (if attribute value is a file)."""
+ file: File
"""
- 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.
+ Represents the text of the attribute value, includes formatting.
+
+ Rich text format. For reference see https://editorjs.io/
"""
- filterableInStorefront: Boolean! @deprecated
+ richText: JSONString
"""
- 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.
+ Represents the text of the attribute value, plain text without formatting.
"""
- filterableInDashboard: Boolean!
+ 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."""
+ externalReference: String
+}
+
+"""Represents attribute value translations."""
+type AttributeValueTranslation implements Node {
+ """The ID of the attribute value translation."""
+ id: ID!
+
+ """Translation language."""
+ language: LanguageDisplay!
+
+ """Translated attribute value name."""
+ name: String!
"""
- 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.
+ Translated rich-text attribute value.
+
+ Rich text format. For reference see https://editorjs.io/
"""
- availableInGrid: Boolean! @deprecated
+ richText: JSONString
+
+ """Translated plain text attribute value ."""
+ plainText: String
+
+ """Represents the attribute value fields to translate."""
+ translatableContent: AttributeValueTranslatableContent
+}
+
+"""
+Represents attribute value's original translatable fields and related translations.
+"""
+type AttributeValueTranslatableContent implements Node {
+ """The ID of the attribute value translatable content."""
+ id: ID!
+
+ """The ID of the attribute value to translate."""
+ attributeValueId: ID!
+
+ """Name of the attribute value to translate."""
+ name: String!
"""
- 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.
+ Attribute value.
+
+ Rich text format. For reference see https://editorjs.io/
"""
- storefrontSearchPosition: Int! @deprecated
+ 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: "Get model fields from the root level queries.")
+
+ """Associated attribute that can be translated."""
+ attribute: AttributeTranslatableContent
+}
+
+"""
+Represents attribute's original translatable fields and related translations.
+"""
+type AttributeTranslatableContent implements Node {
+ """The ID of the attribute translatable content."""
+ id: ID!
+
+ """The ID of the attribute to translate."""
+ attributeId: ID!
+
+ """Name of the attribute to translate."""
+ name: String!
"""Returns translated attribute fields for the given language code."""
translation(
@@ -6086,90 +8029,105 @@ type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes")
languageCode: LanguageCodeEnum!
): AttributeTranslation
- """Flag indicating that attribute has predefined choices."""
- withChoices: Boolean!
+ """Custom attribute of a product."""
+ attribute: Attribute @deprecated(reason: "Get model fields from the root level queries.")
+}
- """
- A list of product types that use this attribute as a product attribute.
- """
- productTypes(
- """Return the elements in the list that come before the specified cursor."""
- before: String
+"""Represents attribute translations."""
+type AttributeTranslation implements Node {
+ """The ID of the attribute translation."""
+ id: ID!
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """Translation language."""
+ language: LanguageDisplay!
- """
- 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
+ """Translated attribute name."""
+ name: String!
- """
- 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!
+ """Represents the attribute fields to translate."""
+ translatableContent: AttributeTranslatableContent
+}
- """
- A list of product types that use this attribute as a product variant attribute.
- """
- productVariantTypes(
- """Return the elements in the list that come before the specified cursor."""
- before: String
+type File {
+ """The URL of the file."""
+ url: String!
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """Content type of the file."""
+ contentType: 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
+"""
+The `Date` scalar type represents a Date
+value as specified by
+[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
+"""
+scalar Date
- """
- 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!
+input AttributeChoicesSortingInput {
+ """Specifies the direction in which to sort attribute choices."""
+ direction: OrderDirection!
- """External ID of this attribute."""
- externalReference: String
+ """Sort attribute choices by the selected field."""
+ field: AttributeChoicesSortField!
}
-enum AttributeInputTypeEnum @doc(category: "Attributes") {
- DROPDOWN
- MULTISELECT
- FILE
- REFERENCE
- SINGLE_REFERENCE
- NUMERIC
- RICH_TEXT
- PLAIN_TEXT
- SWATCH
- BOOLEAN
- DATE
- DATE_TIME
+enum OrderDirection {
+ """Specifies an ascending sort order."""
+ ASC
+
+ """Specifies a descending sort order."""
+ DESC
}
-enum AttributeEntityTypeEnum @doc(category: "Attributes") {
- PAGE
- PRODUCT
- PRODUCT_VARIANT
- CATEGORY
- COLLECTION
+enum AttributeChoicesSortField {
+ """Sort attribute choice by name."""
+ NAME
+
+ """Sort attribute choice by slug."""
+ SLUG
}
-"""
-The reference types (product or page type) that are used to narrow down the choices of reference objects.
-ProductType applicable for reference attribute with `PRODUCT` or `PRODUCT_VARIANT` entity type.
-PageType applicable for reference attribute with `PAGE` entity type.
-"""
-union ReferenceType = ProductType | PageType
+input AttributeValueFilterInput {
+ search: String
+ ids: [ID!]
+ slugs: [String!]
+}
+
+"""Where filtering options for attribute values."""
+input AttributeValueWhereInput {
+ ids: [ID!]
+ name: StringFilterInput
+ slug: StringFilterInput
+
+ """List of conditions that must be met."""
+ AND: [AttributeValueWhereInput!]
+
+ """A list of conditions of which at least one must be met."""
+ OR: [AttributeValueWhereInput!]
+}
+
+type ProductTypeCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [ProductTypeCountableEdge!]!
+
+ """A total count of items in the collection."""
+ totalCount: Int
+}
+
+type ProductTypeCountableEdge {
+ """The item at the end of the edge."""
+ node: ProductType!
+
+ """A cursor for use in pagination."""
+ cursor: String!
+}
"""
-Represents a type of product. It defines what attributes are available to products of this type.
+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 ProductType implements Node & ObjectWithMetadata @doc(category: "Products") {
- """The ID of the product type."""
+type Category implements Node & ObjectWithMetadata {
+ """The ID of the category."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -6202,32 +8160,43 @@ type ProductType implements Node & ObjectWithMetadata @doc(category: "Products")
"""
metafields(keys: [String!]): Metadata
- """Name of the product type."""
- name: String!
+ """SEO title of category."""
+ seoTitle: String
- """Slug of the product type."""
- slug: String!
+ """SEO description of category."""
+ seoDescription: String
- """Whether the product type has variants."""
- hasVariants: Boolean!
+ """Name of category"""
+ name: String!
- """Whether shipping is required for this product type."""
- isShippingRequired: Boolean!
+ """
+ Description of the category.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ description: JSONString
- """Whether the product type is digital."""
- isDigital: Boolean!
+ """Slug of the category."""
+ slug: String!
- """Weight of the product type."""
- weight: Weight
+ """Parent category."""
+ parent: Category
- """The product type kind."""
- kind: ProductTypeKindEnum!
+ """Level of the category."""
+ level: Int!
- """List of products of this type."""
- products(
- """Slug of a channel for which the data should be returned."""
- channel: String
+ """
+ Description of the category.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.")
+
+ """The date and time when the category was last updated."""
+ updatedAt: DateTime!
+ """List of ancestors of the category."""
+ ancestors(
"""Return the elements in the list that come before the specified cursor."""
before: String
@@ -6243,50 +8212,50 @@ type ProductType implements Node & ObjectWithMetadata @doc(category: "Products")
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: "Use the top-level `products` query with the `productTypes` filter.")
-
- """A type of tax. Assigned by enabled tax gateway"""
- taxType: TaxType @deprecated(reason: "Use `taxClass` field instead.")
+ ): CategoryCountableConnection
"""
- 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.
+ List of products in the category. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
"""
- taxClass: TaxClass
+ products(
+ """
+ Filtering options for products.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: ProductFilterInput
- """Variant attributes of that product type."""
- variantAttributes(
- """Define scope of returned attributes."""
- variantSelection: VariantAttributeScope
- ): [Attribute!] @deprecated(reason: "Use `assignedVariantAttributes` instead.")
+ """Where filtering options for products."""
+ where: ProductWhereInput
- """
- Variant attributes of that product type with attached variant selection.
- """
- assignedVariantAttributes(
- """Define scope of returned attributes."""
- variantSelection: VariantAttributeScope
- ): [AssignedVariantAttribute!]
+ """Sort products."""
+ sortBy: ProductOrder
- """Product attributes of that product type."""
- productAttributes: [Attribute!]
+ """Search products."""
+ search: String
- """
- List of attributes which can be assigned to this product type.
-
- Requires one of the following permissions: MANAGE_PRODUCTS.
- """
- availableAttributes(
- """Filtering options for attributes of this product type."""
- filter: AttributeFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """Slug of a channel for which the data should be returned."""
+ channel: String
- """Where filtering options for attributes of this product type."""
- where: AttributeWhereInput
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """Search attributes."""
- search: 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
@@ -6302,588 +8271,563 @@ type ProductType implements Node & ObjectWithMetadata @doc(category: "Products")
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
-}
+ ): CategoryCountableConnection
-enum ProductTypeKindEnum @doc(category: "Products") {
- NORMAL
- GIFT_CARD
-}
+ """Background image of the category."""
+ 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
-"""Representation of tax types fetched from tax gateway."""
-type TaxType @doc(category: "Taxes") {
- """Description of the tax type."""
- description: String
+ """
+ The format of the image. When not provided, format of the original image will be used.
+ """
+ format: ThumbnailFormatEnum
+ ): Image
- """External tax code used to identify given tax group."""
- taxCode: String
+ """Returns translated category fields for the given language code."""
+ translation(
+ """A language code to return the translation for category."""
+ languageCode: LanguageCodeEnum!
+ ): CategoryTranslation
}
-"""
-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.
-"""
-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!]!
+type CategoryCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [CategoryCountableEdge!]!
- """
- A single key from private metadata. Requires staff permissions to access.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- privateMetafield(key: String!): String
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """
- 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
+type CategoryCountableEdge {
+ """The item at the end of the edge."""
+ node: Category!
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """
- A single key from public metadata.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- metafield(key: String!): String
+input ProductFilterInput {
+ isPublished: Boolean
+ collections: [ID!]
+ categories: [ID!]
+ hasCategory: Boolean
+ attributes: [AttributeInput!]
- """
- Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
- """
- metafields(keys: [String!]): Metadata
+ """Filter by variants having specific stock status."""
+ stockAvailability: StockAvailability
+ stocks: ProductStockFilterInput
+ search: String
+ metadata: [MetadataFilter!]
- """Name of the tax class."""
- name: String!
+ """Filter by the publication date."""
+ publishedFrom: DateTime
- """Country-specific tax rates for this tax class."""
- countries: [TaxClassCountryRate!]!
-}
+ """Filter by availability for purchase."""
+ isAvailable: Boolean
-"""
-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.
-"""
-type TaxClassCountryRate @doc(category: "Taxes") {
- """Country in which this tax rate applies."""
- country: CountryDisplay!
+ """Filter by the date of availability for purchase."""
+ availableFrom: DateTime
- """Tax rate value."""
- rate: Float!
+ """Filter by visibility in product listings."""
+ isVisibleInListing: Boolean
+ price: PriceRangeInput
- """Related tax class."""
- taxClass: TaxClass
-}
+ """Filter by the lowest variant price after discounts."""
+ minimalPrice: PriceRangeInput
-enum VariantAttributeScope @doc(category: "Products") {
- ALL
- VARIANT_SELECTION
- NOT_VARIANT_SELECTION
-}
+ """Filter by when was the most recent update."""
+ updatedAt: DateTimeRangeInput
+ productTypes: [ID!]
-"""
-Represents assigned attribute to variant with variant selection attached.
-"""
-type AssignedVariantAttribute @doc(category: "Attributes") {
- """Attribute assigned to variant."""
- attribute: Attribute!
+ """Filter on whether product is a gift card or not."""
+ giftCard: Boolean
+ ids: [ID!]
+ hasPreorderedVariants: Boolean
+ slugs: [String!]
"""
- Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric']
+ Specifies the channel by which the data should be filtered.
+
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
"""
- variantSelection: Boolean!
+ channel: String
}
-type AttributeCountableConnection @doc(category: "Attributes") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [AttributeCountableEdge!]!
-
- """A total count of items in the collection."""
- totalCount: Int
-}
+input AttributeInput {
+ """Internal representation of an attribute name."""
+ slug: String
-type AttributeCountableEdge @doc(category: "Attributes") {
- """The item at the end of the edge."""
- node: Attribute!
+ """
+ Filter by value of the attribute. Only one value input field is allowed. If provided more than one, the error will be raised. Cannot be combined with deprecated fields of `AttributeInput`.
+ """
+ value: AssignedAttributeValueInput
- """A cursor for use in pagination."""
- cursor: String!
-}
+ """
+ Slugs identifying the attributeValues associated with the Attribute. When specified, it filters the results to include only records with one of the matching values. Requires `slug` to be provided.
+
+ DEPRECATED: this field will be removed. Use `value` instead.
+ """
+ values: [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!]
+ """
+ The range that the returned values should be in. Requires `slug` to be provided.
+
+ DEPRECATED: this field will be removed. Use `value` instead.
+ """
+ valuesRange: IntRangeInput
- """Specifies the channel by which the data should be filtered."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
-}
+ """
+ The date/time range that the returned values should be in. Requires `slug` to be provided.
+
+ DEPRECATED: this field will be removed. Use `value` instead.
+ """
+ dateTime: DateTimeRangeInput
-input MetadataFilter {
- """Key of a metadata item."""
- key: String!
+ """
+ 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. Requires `slug` to be provided.
+
+ DEPRECATED: this field will be removed. Use `value` instead.
+ """
+ date: DateRangeInput
- """Value of a metadata item."""
- value: String
+ """
+ The boolean value of the attribute. Requires `slug` to be provided.
+
+ DEPRECATED: this field will be removed. Use `value` instead.
+ """
+ boolean: Boolean
}
-enum AttributeTypeEnum @doc(category: "Attributes") {
- PRODUCT_TYPE
- PAGE_TYPE
-}
+input AssignedAttributeValueInput {
+ """Filter by slug assigned to AttributeValue."""
+ slug: StringFilterInput
-"""Where filtering options."""
-input AttributeWhereInput @doc(category: "Attributes") {
- metadata: [MetadataFilter!]
- ids: [ID!]
+ """Filter by name assigned to AttributeValue."""
name: StringFilterInput
- slug: StringFilterInput
- withChoices: Boolean
- inputType: AttributeInputTypeEnumFilterInput
- entityType: AttributeEntityTypeEnumFilterInput
- type: AttributeTypeEnumFilterInput
- unit: MeasurementUnitsEnumFilterInput
- inCollection: ID
- inCategory: ID
- valueRequired: Boolean
- visibleInStorefront: Boolean
- filterableInDashboard: Boolean
- """List of conditions that must be met."""
- AND: [AttributeWhereInput!]
+ """Filter by numeric value for attributes of numeric type."""
+ numeric: DecimalFilterInput
- """A list of conditions of which at least one must be met."""
- OR: [AttributeWhereInput!]
-}
+ """Filter by date value for attributes of date type."""
+ date: DateRangeInput
-"""Define the filtering options for string fields."""
-input StringFilterInput {
- """The value equal to."""
- eq: String
+ """Filter by date time value for attributes of date time type."""
+ dateTime: DateTimeRangeInput
- """The value included in."""
- oneOf: [String!]
+ """Filter by boolean value for attributes of boolean type."""
+ boolean: Boolean
+
+ """Filter by reference attribute value."""
+ reference: AssignedAttributeReferenceInput
}
-input AttributeInputTypeEnumFilterInput @doc(category: "Attributes") {
+"""Define the filtering options for decimal fields."""
+input DecimalFilterInput {
"""The value equal to."""
- eq: AttributeInputTypeEnum
+ eq: Decimal
"""The value included in."""
- oneOf: [AttributeInputTypeEnum!]
+ oneOf: [Decimal!]
+
+ """The value in range."""
+ range: DecimalRangeInput
}
-input AttributeEntityTypeEnumFilterInput @doc(category: "Attributes") {
- """The value equal to."""
- eq: AttributeEntityTypeEnum
+"""
+Custom Decimal implementation.
- """The value included in."""
- oneOf: [AttributeEntityTypeEnum!]
-}
+Returns Decimal as a float in the API,
+parses float to the Decimal on the way back.
+"""
+scalar Decimal
-input AttributeTypeEnumFilterInput @doc(category: "Attributes") {
- """The value equal to."""
- eq: AttributeTypeEnum
+input DecimalRangeInput {
+ """Decimal value greater than or equal to."""
+ gte: Decimal
- """The value included in."""
- oneOf: [AttributeTypeEnum!]
+ """Decimal value less than or equal to."""
+ lte: Decimal
}
-input MeasurementUnitsEnumFilterInput @doc(category: "Attributes") {
- """The value equal to."""
- eq: MeasurementUnitsEnum
+input DateRangeInput {
+ """Start date."""
+ gte: Date
- """The value included in."""
- oneOf: [MeasurementUnitsEnum!]
+ """End date."""
+ lte: Date
}
-enum MeasurementUnitsEnum {
- MM
- CM
- DM
- M
- KM
- FT
- YD
- INCH
- SQ_MM
- SQ_CM
- SQ_DM
- 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
-}
+input DateTimeRangeInput {
+ """Start date."""
+ gte: DateTime
-"""
-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 of the page type."""
- id: ID!
+ """End date."""
+ lte: DateTime
+}
- """List of private metadata items. Requires staff permissions to access."""
- privateMetadata: [MetadataItem!]!
+input AssignedAttributeReferenceInput {
+ """
+ Returns objects with a reference pointing to an object identified by the given ID.
+ """
+ referencedIds: ContainsFilterInput
"""
- A single key from private metadata. Requires staff permissions to access.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
+ Returns objects with a reference pointing to a page identified by the given slug.
"""
- privateMetafield(key: String!): String
+ pageSlugs: ContainsFilterInput
"""
- Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
+ Returns objects with a reference pointing to a product identified by the given slug.
"""
- privateMetafields(keys: [String!]): Metadata
+ productSlugs: ContainsFilterInput
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ """
+ Returns objects with a reference pointing to a product variant identified by the given sku.
+ """
+ productVariantSkus: ContainsFilterInput
"""
- A single key from public metadata.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
+ Returns objects with a reference pointing to a category identified by the given slug.
"""
- metafield(key: String!): String
+ categorySlugs: ContainsFilterInput
"""
- Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
+ Returns objects with a reference pointing to a collection identified by the given slug.
"""
- metafields(keys: [String!]): Metadata
+ collectionSlugs: ContainsFilterInput
+}
- """Name of the page type."""
- name: String!
+"""
+Define the filtering options for fields that can contain multiple values.
+"""
+input ContainsFilterInput {
+ """The field contains at least one of the specified values."""
+ containsAny: [String!]
- """Slug of the page type."""
- slug: String!
+ """The field contains all of the specified values."""
+ containsAll: [String!]
+}
- """Page attributes of that page type."""
- attributes: [Attribute!]
+input IntRangeInput {
+ """Value greater than or equal to."""
+ gte: Int
- """
- Attributes that can be assigned to the page type.
-
- Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
- """
- availableAttributes(
- """Filtering options for attributes."""
- filter: AttributeFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """Value less than or equal to."""
+ lte: Int
+}
- """Where filtering options for attributes."""
- where: AttributeWhereInput
+enum StockAvailability {
+ IN_STOCK
+ OUT_OF_STOCK
+}
- """Search attributes."""
- search: String
+input ProductStockFilterInput {
+ warehouseIds: [ID!]
+ quantity: IntRangeInput
+}
- """Return the elements in the list that come before the specified cursor."""
- before: String
+input PriceRangeInput {
+ """Price greater than or equal to."""
+ gte: Float
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """Price less than or equal to."""
+ lte: Float
+}
- """
- 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
+input ProductWhereInput {
+ metadata: [MetadataFilter!]
+ ids: [ID!]
- """
- 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
+ """Filter by product name."""
+ name: StringFilterInput
- """
- Whether page type has pages assigned.
-
- Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
- """
- hasPages: Boolean
-}
+ """Filter by product slug."""
+ slug: StringFilterInput
-"""
-Positive Integer scalar implementation.
+ """Filter by product type."""
+ productType: GlobalIDFilterInput
-Should be used in places where value must be positive (greater than 0).
-"""
-scalar PositiveInt
+ """Filter by product category."""
+ category: GlobalIDFilterInput
-type AttributeValueCountableConnection @doc(category: "Attributes") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [AttributeValueCountableEdge!]!
+ """Filter by collection."""
+ collection: GlobalIDFilterInput
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """Filter by availability for purchase."""
+ isAvailable: Boolean
-type AttributeValueCountableEdge @doc(category: "Attributes") {
- """The item at the end of the edge."""
- node: AttributeValue!
+ """Filter by public visibility."""
+ isPublished: Boolean
- """A cursor for use in pagination."""
- cursor: String!
-}
+ """Filter by visibility on the channel."""
+ isVisibleInListing: Boolean
-"""Represents a value of an attribute."""
-type AttributeValue implements Node @doc(category: "Attributes") {
- """The ID of the attribute value."""
- id: ID!
+ """Filter by the publication date."""
+ publishedFrom: DateTime
- """Name of a value displayed in the interface."""
- name: String
+ """Filter by the date of availability for purchase."""
+ availableFrom: DateTime
- """Internal representation of a value (unique per attribute)."""
- slug: String
+ """Filter by product with category assigned."""
+ hasCategory: Boolean
- """
- Represent value of the attribute value (e.g. color values for swatch attributes).
- """
- value: String
+ """Filter by product variant price."""
+ price: DecimalFilterInput
- """Returns translated attribute value fields for the given language code."""
- translation(
- """A language code to return the translation for attribute value."""
- languageCode: LanguageCodeEnum!
- ): AttributeValueTranslation
+ """Filter by the lowest variant price after discounts."""
+ minimalPrice: DecimalFilterInput
- """The input type to use for entering attribute values in the dashboard."""
- inputType: AttributeInputTypeEnum
+ """Filter by attributes associated with the product."""
+ attributes: [AttributeInput!]
- """The ID of the referenced object."""
- reference: ID
+ """Filter by variants having specific stock status."""
+ stockAvailability: StockAvailability
- """Represents file URL and content type (if attribute value is a file)."""
- file: File
+ """Filter by stock of the product variant."""
+ stocks: ProductStockFilterInput
- """
- Represents the text of the attribute value, includes formatting.
-
- Rich text format. For reference see https://editorjs.io/
- """
- richText: JSONString
+ """Filter on whether product is a gift card or not."""
+ giftCard: Boolean
- """
- Represents the text of the attribute value, plain text without formatting.
- """
- plainText: String
+ """Filter by product with preordered variants."""
+ hasPreorderedVariants: Boolean
- """Represents the boolean value of the attribute value."""
- boolean: Boolean
+ """Filter by when was the most recent update."""
+ updatedAt: DateTimeFilterInput
- """Represents the date value of the attribute value."""
- date: Date
+ """List of conditions that must be met."""
+ AND: [ProductWhereInput!]
- """Represents the date/time value of the attribute value."""
- dateTime: DateTime
+ """A list of conditions of which at least one must be met."""
+ OR: [ProductWhereInput!]
+}
- """External ID of this attribute value."""
- externalReference: String
+"""Define the filtering options for foreign key fields."""
+input GlobalIDFilterInput {
+ """The value equal to."""
+ eq: ID
+
+ """The value included in."""
+ oneOf: [ID!]
}
-"""Represents attribute value translations."""
-type AttributeValueTranslation implements Node @doc(category: "Attributes") {
- """The ID of the attribute value translation."""
- id: ID!
+"""Define the filtering options for date time fields."""
+input DateTimeFilterInput {
+ """The value equal to."""
+ eq: DateTime
- """Translation language."""
- language: LanguageDisplay!
+ """The value included in."""
+ oneOf: [DateTime!]
- """Translated attribute value name."""
- name: String!
+ """The value in range."""
+ range: DateTimeRangeInput
+}
+
+input ProductOrder {
+ """Specifies the direction in which to sort products."""
+ direction: OrderDirection!
"""
- Translated rich-text attribute value.
+ Specifies the channel in which to sort the data.
- Rich text format. For reference see https://editorjs.io/
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
"""
- richText: JSONString
+ channel: String
- """Translated plain text attribute value ."""
- plainText: String
+ """
+ Sort product by the selected attribute's values.
+ Note: this doesn't take translations into account yet.
+ """
+ attributeId: ID
- """Represents the attribute value fields to translate."""
- translatableContent: AttributeValueTranslatableContent
+ """Sort products by the selected field."""
+ field: ProductOrderField
}
-"""
-Represents attribute value's original translatable fields and related translations.
-"""
-type AttributeValueTranslatableContent implements Node @doc(category: "Attributes") {
- """The ID of the attribute value translatable content."""
- id: ID!
-
- """The ID of the attribute value to translate."""
- attributeValueId: ID!
+enum ProductOrderField {
+ """Sort products by name."""
+ NAME
- """Name of the attribute value to translate."""
- name: String!
+ """
+ Sort products by rank. Note: This option is available only with the `search` filter.
+ """
+ RANK
"""
- Attribute value.
+ Sort products by price.
- Rich text format. For reference see https://editorjs.io/
+ This option requires a channel filter to work as the values can vary between channels.
"""
- richText: JSONString
-
- """Attribute plain text value."""
- plainText: String
+ PRICE
- """Returns translated attribute value fields for the given language code."""
- translation(
- """A language code to return the translation for attribute value."""
- languageCode: LanguageCodeEnum!
- ): AttributeValueTranslation
+ """
+ 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
- """Represents a value of an attribute."""
- attributeValue: AttributeValue @deprecated(reason: "Get model fields from the root level queries.")
+ """Sort products by update date."""
+ LAST_MODIFIED @deprecated(reason: "Use `LAST_MODIFIED_AT` instead.")
- """Associated attribute that can be translated."""
- attribute: AttributeTranslatableContent
-}
+ """Sort products by update date."""
+ DATE @deprecated(reason: "Use `LAST_MODIFIED_AT` instead.")
-"""
-Represents attribute's original translatable fields and related translations.
-"""
-type AttributeTranslatableContent implements Node @doc(category: "Attributes") {
- """The ID of the attribute translatable content."""
- id: ID!
+ """Sort products by type."""
+ TYPE
- """The ID of the attribute to translate."""
- attributeId: ID!
+ """
+ Sort products by publication status.
+
+ This option requires a channel filter to work as the values can vary between channels.
+ """
+ PUBLISHED
- """Name of the attribute to translate."""
- name: String!
+ """
+ Sort products by publication date.
+
+ This option requires a channel filter to work as the values can vary between channels.
+ """
+ PUBLICATION_DATE @deprecated(reason: "Use `PUBLISHED_AT` instead.")
- """Returns translated attribute fields for the given language code."""
- translation(
- """A language code to return the translation for attribute."""
- languageCode: LanguageCodeEnum!
- ): AttributeTranslation
+ """
+ Sort products by publication date.
+
+ This option requires a channel filter to work as the values can vary between channels.
+ """
+ PUBLISHED_AT
- """Custom attribute of a product."""
- attribute: Attribute @deprecated(reason: "Get model fields from the root level queries.")
+ """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."""
+ CREATED_AT
}
-"""Represents attribute translations."""
-type AttributeTranslation implements Node @doc(category: "Attributes") {
- """The ID of the attribute translation."""
+"""Represents an image."""
+type Image {
+ """The URL of the image."""
+ url: String!
+
+ """Alt text for an image."""
+ alt: String
+}
+
+enum ThumbnailFormatEnum {
+ ORIGINAL
+ AVIF
+ WEBP
+}
+
+"""Represents category translations."""
+type CategoryTranslation implements Node {
+ """The ID of the category translation."""
id: ID!
"""Translation language."""
language: LanguageDisplay!
- """Translated attribute name."""
- name: String!
+ """Translated SEO title."""
+ seoTitle: String
- """Represents the attribute fields to translate."""
- translatableContent: AttributeTranslatableContent
-}
+ """Translated SEO description."""
+ seoDescription: String
-type File {
- """The URL of the file."""
- url: String!
+ """
+ Translated category slug.
+
+ Added in Saleor 3.21.
+ """
+ slug: String
- """Content type of the file."""
- contentType: String
-}
+ """Translated category name."""
+ name: String
-"""
-The `Date` scalar type represents a Date
-value as specified by
-[iso8601](https://en.wikipedia.org/wiki/ISO_8601).
-"""
-scalar Date
+ """
+ Translated description of the category.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ description: JSONString
-input AttributeChoicesSortingInput @doc(category: "Attributes") {
- """Specifies the direction in which to sort attribute choices."""
- direction: OrderDirection!
+ """
+ Translated description of the category.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.")
- """Sort attribute choices by the selected field."""
- field: AttributeChoicesSortField!
+ """Represents the category fields to translate."""
+ translatableContent: CategoryTranslatableContent
}
-enum AttributeChoicesSortField @doc(category: "Attributes") {
- """Sort attribute choice by name."""
- NAME
+"""
+Represents category original translatable fields and related translations.
+"""
+type CategoryTranslatableContent implements Node {
+ """The ID of the category translatable content."""
+ id: ID!
- """Sort attribute choice by slug."""
- SLUG
-}
+ """The ID of the category to translate."""
+ categoryId: ID!
-input AttributeValueFilterInput @doc(category: "Attributes") {
- search: String
- ids: [ID!]
- slugs: [String!]
-}
+ """SEO title to translate."""
+ seoTitle: String
-"""Where filtering options for attribute values."""
-input AttributeValueWhereInput @doc(category: "Attributes") {
- ids: [ID!]
- name: StringFilterInput
- slug: StringFilterInput
+ """SEO description to translate."""
+ seoDescription: String
- """List of conditions that must be met."""
- AND: [AttributeValueWhereInput!]
+ """
+ Slug to translate.
+
+ Added in Saleor 3.21.
+ """
+ slug: String
- """A list of conditions of which at least one must be met."""
- OR: [AttributeValueWhereInput!]
-}
+ """Name of the category translatable content."""
+ name: String!
-type ProductTypeCountableConnection @doc(category: "Products") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [ProductTypeCountableEdge!]!
+ """
+ Category description to translate.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ description: JSONString
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """
+ Description of the category.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.")
-type ProductTypeCountableEdge @doc(category: "Products") {
- """The item at the end of the edge."""
- node: ProductType!
+ """Returns translated category fields for the given language code."""
+ translation(
+ """A language code to return the translation for category."""
+ languageCode: LanguageCodeEnum!
+ ): CategoryTranslation
- """A cursor for use in pagination."""
- cursor: String!
+ """Represents a single category of products."""
+ category: Category @deprecated(reason: "Get model fields from the root level queries.")
}
-"""
-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") {
- """The ID of the category."""
+"""Represents a version of a product such as different size or color."""
+type ProductVariant implements Node & ObjectWithMetadata & ObjectWithAttributes {
+ """The ID of the product variant."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -6916,911 +8860,241 @@ type Category implements Node & ObjectWithMetadata @doc(category: "Products") {
"""
metafields(keys: [String!]): Metadata
- """SEO title of category."""
- seoTitle: String
-
- """SEO description of category."""
- seoDescription: String
-
- """Name of category"""
- name: String!
-
"""
- Description of the category.
+ Get a single attribute attached to product by attribute slug.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.22.
"""
- description: JSONString
-
- """Slug of the category."""
- slug: String!
-
- """Parent category."""
- parent: Category
-
- """Level of the category."""
- level: Int!
+ assignedAttribute(
+ """Slug of the attribute"""
+ slug: String!
+ ): AssignedAttribute
"""
- Description of the category.
+ List of attributes assigned to this variant.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.22.
"""
- descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.")
+ assignedAttributes(
+ """Maximum number of attributes to return. Default is 100."""
+ limit: PositiveInt = 100
+ ): [AssignedAttribute!]!
- """The date and time when the category was last updated."""
- updatedAt: DateTime!
+ """The name of the product variant."""
+ name: String!
- """List of ancestors of the category."""
- ancestors(
- """Return the elements in the list that come before the specified cursor."""
- before: String
+ """The SKU (stock keeping unit) of the product variant."""
+ sku: String
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """The product to which the variant belongs."""
+ product: Product!
- """
- 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
+ """
+ Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. If the field is not provided, `Shop.trackInventoryByDefault` will be used.
+ """
+ trackInventory: Boolean!
- """
- 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
+ """The maximum quantity of this variant that a customer can purchase."""
+ quantityLimitPerCustomer: Int
+
+ """The weight of the product variant."""
+ weight: Weight
"""
- List of products in the category. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
+ Channel given to retrieve this product variant. Also used by federation gateway to resolve this object in a federated query.
"""
- products(
- """Filtering options for products."""
- filter: ProductFilterInput @deprecated(reason: "Use `where` filter instead.")
+ channel: String
- """Where filtering options for products."""
- where: ProductWhereInput
+ """
+ List of price information in channels for the product.
+
+ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER.
+ """
+ channelListings: [ProductVariantChannelListing!]
- """Sort products."""
- sortBy: ProductOrder
+ """
+ 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
- """Search products."""
- search: String
+ """List of attributes assigned to this variant."""
+ attributes(
+ """Define scope of returned attributes."""
+ variantSelection: VariantAttributeScope
+ ): [SelectedAttribute!]! @deprecated(reason: "Use the `assignedAttributes` field instead.")
- """Slug of a channel for which the data should be returned."""
- channel: String
+ """Gross margin percentage value."""
+ margin: Int
- """Return the elements in the list that come before the specified cursor."""
- before: String
+ """
+ Total quantity ordered.
+
+ Requires one of the following permissions: MANAGE_PRODUCTS.
+ """
+ quantityOrdered: Int
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """
+ 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
- """
- 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
+ """List of images for the product variant."""
+ images: [ProductImage!] @deprecated(reason: "Use the `media` field instead.")
- """
- 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 media for the product variant."""
+ media: [ProductMedia!]
- """List of children of the category."""
- children(
- """Return the elements in the list that come before the specified cursor."""
- before: 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
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """
+ 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(
"""
- Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.
+ 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.
"""
- first: Int
+ address: AddressInput
"""
- Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query.
+ Two-letter ISO 3166-1 country code.
+
+ DEPRECATED: this field will be removed. Use `address` argument instead.
"""
- last: Int
- ): CategoryCountableConnection
+ countryCode: CountryCode
+ ): [Stock!]
- """Background image of the category."""
- backgroundImage(
+ """
+ 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(
"""
- Desired longest side the image in pixels. Defaults to 4096. Images are never cropped. Pass 0 to retrieve the original size (not recommended).
+ 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.
"""
- size: Int
+ address: AddressInput
"""
- The format of the image. When not provided, format of the original image will be used.
+ 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. Use `address` argument instead.
"""
- 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
-}
+ countryCode: CountryCode
+ ): Int
-type CategoryCountableConnection @doc(category: "Products") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [CategoryCountableEdge!]!
+ """Preorder data for product variant."""
+ preorder: PreorderData
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """The date and time when the product variant was created."""
+ created: DateTime!
-type CategoryCountableEdge @doc(category: "Products") {
- """The item at the end of the edge."""
- node: Category!
+ """The date and time when the product variant was last updated."""
+ updatedAt: DateTime!
- """A cursor for use in pagination."""
- cursor: String!
+ """External ID of this product."""
+ externalReference: 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!]
+"""Represents product variant channel listing."""
+type ProductVariantChannelListing implements Node {
+ """The ID of the variant channel listing."""
+ id: ID!
- """Filter by the publication date."""
- publishedFrom: DateTime
+ """The channel to which the variant listing belongs."""
+ channel: Channel!
- """Filter by availability for purchase."""
- isAvailable: Boolean
+ """The price of the variant."""
+ price: Money
- """Filter by the date of availability for purchase."""
- availableFrom: DateTime
+ """Cost price of the variant."""
+ costPrice: Money
- """Filter by visibility in product listings."""
- isVisibleInListing: Boolean
- price: PriceRangeInput
+ """
+ Prior price of the variant used for discount calculations.
+
+ Added in Saleor 3.21.
+ """
+ priorPrice: Money
- """Filter by the lowest variant price after discounts."""
- minimalPrice: PriceRangeInput
+ """
+ Gross margin percentage value.
+
+ Requires one of the following permissions: MANAGE_PRODUCTS.
+ """
+ margin: Int
- """Filter by when was the most recent update."""
- updatedAt: DateTimeRangeInput
- productTypes: [ID!]
+ """Preorder variant data."""
+ preorderThreshold: PreorderThreshold
+}
- """Filter on whether product is a gift card or not."""
- giftCard: Boolean
- ids: [ID!]
- hasPreorderedVariants: Boolean
- slugs: [String!]
+"""Represents preorder variant data for channel."""
+type PreorderThreshold {
+ """Preorder threshold for product variant in this channel."""
+ quantity: Int
- """Specifies the channel by which the data should be filtered."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
+ """Number of sold product variant in this channel."""
+ soldUnits: Int!
}
-input AttributeInput @doc(category: "Attributes") {
- """Internal representation of an attribute name."""
- slug: String
+"""Represents availability of a variant in the storefront."""
+type VariantPricingInfo {
+ """Whether it is in sale or not."""
+ onSale: Boolean
- """
- Filter by value of the attribute. Only one value input field is allowed. If provided more than one, the error will be raised. Cannot be combined with deprecated fields of `AttributeInput`.
- """
- value: AssignedAttributeValueInput
+ """The discount amount if in sale (null otherwise)."""
+ discount: TaxedMoney
"""
- Slugs identifying the attributeValues associated with the Attribute. When specified, it filters the results to include only records with one of the matching values. Requires `slug` to be provided.
+ The discount amount compared to prior price. Null if product is not on sale or prior price was not provided in VariantChannelListing
+
+ Added in Saleor 3.21.
"""
- values: [String!] @deprecated(reason: "Use `value` instead.")
+ discountPrior: TaxedMoney
- """
- The range that the returned values should be in. Requires `slug` to be provided.
- """
- valuesRange: IntRangeInput @deprecated(reason: "Use `value` instead.")
+ """The discount amount in the local currency."""
+ discountLocalCurrency: TaxedMoney @deprecated(reason: "Always returns `null`.")
- """
- The date/time range that the returned values should be in. Requires `slug` to be provided.
- """
- dateTime: DateTimeRangeInput @deprecated(reason: "Use `value` instead.")
+ """The price, with any discount subtracted."""
+ price: TaxedMoney
+
+ """The price without any discount."""
+ priceUndiscounted: TaxedMoney
"""
- 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. Requires `slug` to be provided.
+ The price prior to discount.
+
+ Added in Saleor 3.21.
"""
- date: DateRangeInput @deprecated(reason: "Use `value` instead.")
+ pricePrior: TaxedMoney
- """The boolean value of the attribute. Requires `slug` to be provided."""
- boolean: Boolean @deprecated(reason: "Use `value` instead.")
+ """The discounted price in the local currency."""
+ priceLocalCurrency: TaxedMoney @deprecated(reason: "Always returns `null`.")
}
-input AssignedAttributeValueInput {
- """Filter by slug assigned to AttributeValue."""
- slug: StringFilterInput
-
- """Filter by name assigned to AttributeValue."""
- name: StringFilterInput
-
- """Filter by numeric value for attributes of numeric type."""
- numeric: DecimalFilterInput
-
- """Filter by date value for attributes of date type."""
- date: DateRangeInput
-
- """Filter by date time value for attributes of date time type."""
- dateTime: DateTimeRangeInput
-
- """Filter by boolean value for attributes of boolean type."""
- boolean: Boolean
-
- """Filter by reference attribute value."""
- reference: AssignedAttributeReferenceInput
-}
-
-"""Define the filtering options for decimal fields."""
-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 DateRangeInput {
- """Start date."""
- gte: Date
-
- """End date."""
- lte: Date
-}
-
-input DateTimeRangeInput {
- """Start date."""
- gte: DateTime
-
- """End date."""
- lte: DateTime
-}
-
-input AssignedAttributeReferenceInput {
- """
- Returns objects with a reference pointing to an object identified by the given ID.
- """
- referencedIds: ContainsFilterInput
-
- """
- Returns objects with a reference pointing to a page identified by the given slug.
- """
- pageSlugs: ContainsFilterInput
-
- """
- Returns objects with a reference pointing to a product identified by the given slug.
- """
- productSlugs: ContainsFilterInput
-
- """
- Returns objects with a reference pointing to a product variant identified by the given sku.
- """
- productVariantSkus: ContainsFilterInput
-
- """
- Returns objects with a reference pointing to a category identified by the given slug.
- """
- categorySlugs: ContainsFilterInput
-
- """
- Returns objects with a reference pointing to a collection identified by the given slug.
- """
- collectionSlugs: ContainsFilterInput
-}
-
-"""
-Define the filtering options for fields that can contain multiple values.
-"""
-input ContainsFilterInput {
- """The field contains at least one of the specified values."""
- containsAny: [String!]
-
- """The field contains all of the specified values."""
- containsAll: [String!]
-}
-
-input IntRangeInput {
- """Value greater than or equal to."""
- gte: Int
-
- """Value less than or equal to."""
- lte: Int
-}
-
-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: DateTimeFilterInput
-
- """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."""
-input GlobalIDFilterInput {
- """The value equal to."""
- eq: ID
-
- """The value included in."""
- oneOf: [ID!]
-}
-
-"""Define the filtering options for date time fields."""
-input DateTimeFilterInput {
- """The value equal to."""
- eq: DateTime
-
- """The value included in."""
- oneOf: [DateTime!]
-
- """The value in range."""
- range: DateTimeRangeInput
-}
-
-input ProductOrder @doc(category: "Products") {
- """Specifies the direction in which to sort products."""
- direction: OrderDirection!
-
- """Specifies the channel in which to sort the data."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
-
- """
- 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 @deprecated(reason: "Use `LAST_MODIFIED_AT` instead.")
-
- """Sort products by update date."""
- DATE @deprecated(reason: "Use `LAST_MODIFIED_AT` instead.")
-
- """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 @deprecated(reason: "Use `PUBLISHED_AT` instead.")
-
- """
- 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."""
- CREATED_AT
-}
-
-"""Represents an image."""
-type Image {
- """The URL of the image."""
- url: String!
-
- """Alt text for an image."""
- alt: String
-}
-
-enum ThumbnailFormatEnum {
- ORIGINAL
- AVIF
- WEBP
-}
-
-"""Represents category translations."""
-type CategoryTranslation implements Node @doc(category: "Products") {
- """The ID of the category translation."""
- id: ID!
-
- """Translation language."""
- language: LanguageDisplay!
-
- """Translated SEO title."""
- seoTitle: String
-
- """Translated SEO description."""
- seoDescription: String
-
- """
- Translated category slug.
-
- Added in Saleor 3.21.
- """
- slug: String
-
- """Translated category name."""
- 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: "Use the `description` field instead.")
-
- """Represents the category fields to translate."""
- translatableContent: CategoryTranslatableContent
-}
-
-"""
-Represents category original translatable fields and related translations.
-"""
-type CategoryTranslatableContent implements Node @doc(category: "Products") {
- """The ID of the category translatable content."""
- id: ID!
-
- """The ID of the category to translate."""
- categoryId: ID!
-
- """SEO title to translate."""
- seoTitle: String
-
- """SEO description to translate."""
- seoDescription: String
-
- """
- Slug to translate.
-
- Added in Saleor 3.21.
- """
- slug: String
-
- """Name of the category translatable content."""
- name: String!
-
- """
- Category description to translate.
-
- 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: "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: "Get model fields from the root level queries.")
-}
-
-"""Represents a version of a product such as different size or color."""
-type ProductVariant implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(category: "Products") {
- """The ID of the product variant."""
- 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
-
- """
- Get a single attribute attached to product by attribute slug.
-
- Added in Saleor 3.22.
- """
- assignedAttribute(
- """Slug of the attribute"""
- slug: String!
- ): AssignedAttribute
-
- """
- List of attributes assigned to this variant.
-
- Added in Saleor 3.22.
- """
- assignedAttributes(
- """Maximum number of attributes to return. Default is 100."""
- limit: PositiveInt = 100
- ): [AssignedAttribute!]!
-
- """The name of the product variant."""
- name: String!
-
- """The SKU (stock keeping unit) of the product variant."""
- sku: String
-
- """The product to which the variant belongs."""
- product: Product!
-
- """
- Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. If the field is not provided, `Shop.trackInventoryByDefault` will be used.
- """
- trackInventory: Boolean!
-
- """The maximum quantity of this variant that a customer can purchase."""
- quantityLimitPerCustomer: Int
-
- """The weight of the product variant."""
- 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!]! @deprecated(reason: "Use the `assignedAttributes` field instead.")
-
- """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: "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."""
- countryCode: CountryCode @deprecated(reason: "Use `address` argument instead.")
- ): [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.
- """
- countryCode: CountryCode @deprecated(reason: "Use `address` argument instead.")
- ): Int
-
- """Preorder data for product variant."""
- preorder: PreorderData
-
- """The date and time when the product variant was created."""
- created: DateTime!
-
- """The date and time when the product variant was last updated."""
- updatedAt: DateTime!
-
- """External ID of this product."""
- externalReference: String
-}
-
-"""Represents product variant channel listing."""
-type ProductVariantChannelListing implements Node @doc(category: "Products") {
- """The ID of the variant channel listing."""
- id: ID!
-
- """The channel to which the variant listing belongs."""
- channel: Channel!
-
- """The price of the variant."""
- price: Money
-
- """Cost price of the variant."""
- costPrice: Money
-
- """
- Prior price of the variant used for discount calculations.
-
- Added in Saleor 3.21.
- """
- priorPrice: Money
-
- """
- Gross margin percentage value.
-
- Requires one of the following permissions: MANAGE_PRODUCTS.
- """
- margin: Int
-
- """Preorder variant data."""
- 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 compared to prior price. Null if product is not on sale or prior price was not provided in VariantChannelListing
-
- Added in Saleor 3.21.
- """
- discountPrior: TaxedMoney
-
- """The discount amount in the local currency."""
- discountLocalCurrency: TaxedMoney @deprecated(reason: "Always returns `null`.")
-
- """The price, with any discount subtracted."""
- price: TaxedMoney
-
- """The price without any discount."""
- priceUndiscounted: TaxedMoney
-
- """
- The price prior to discount.
-
- Added in Saleor 3.21.
- """
- pricePrior: TaxedMoney
-
- """The discounted price in the local currency."""
- priceLocalCurrency: TaxedMoney @deprecated(reason: "Always returns `null`.")
-}
-
-"""
-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!
+"""
+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!
@@ -7887,6 +9161,265 @@ input AddressInput {
skipValidation: Boolean = false
}
+"""
+Represents country codes defined by the ISO 3166-1 alpha-2 standard.
+
+The `EU` value is DEPRECATED and will be removed in Saleor 3.21.
+"""
+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
+ XK
+ 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
+}
+
input MetadataInput {
"""Key of a metadata item."""
key: String!
@@ -7896,7 +9429,7 @@ input MetadataInput {
}
"""Represents an assigned attribute to an object."""
-type SelectedAttribute @doc(category: "Attributes") {
+type SelectedAttribute {
"""Name of an attribute displayed in the interface."""
attribute: Attribute!
@@ -7910,7 +9443,7 @@ enum ReportingPeriod {
}
"""Represents a product image."""
-type ProductImage @doc(category: "Products") {
+type ProductImage {
"""The ID of the image."""
id: ID!
@@ -7932,12 +9465,12 @@ type ProductImage @doc(category: "Products") {
"""
The format of the image. When not provided, format of the original image will be used.
"""
- format: ThumbnailFormatEnum = ORIGINAL
+ format: ThumbnailFormatEnum
): String!
}
"""Represents a product media."""
-type ProductMedia implements Node & ObjectWithMetadata @doc(category: "Products") {
+type ProductMedia implements Node & ObjectWithMetadata {
"""The unique ID of the product media."""
id: ID!
@@ -7993,20 +9526,20 @@ type ProductMedia implements Node & ObjectWithMetadata @doc(category: "Products"
"""
The format of the image. When not provided, format of the original image will be used.
"""
- format: ThumbnailFormatEnum = ORIGINAL
+ format: ThumbnailFormatEnum
): String!
"""Product id the media refers to."""
productId: ID
}
-enum ProductMediaType @doc(category: "Products") {
+enum ProductMediaType {
IMAGE
VIDEO
}
"""Represents product variant translations."""
-type ProductVariantTranslation implements Node @doc(category: "Products") {
+type ProductVariantTranslation implements Node {
"""The ID of the product variant translation."""
id: ID!
@@ -8023,7 +9556,7 @@ type ProductVariantTranslation implements Node @doc(category: "Products") {
"""
Represents product variant's original translatable fields and related translations.
"""
-type ProductVariantTranslatableContent implements Node @doc(category: "Products") {
+type ProductVariantTranslatableContent implements Node {
"""The ID of the product variant translatable content."""
id: ID!
@@ -8047,7 +9580,7 @@ type ProductVariantTranslatableContent implements Node @doc(category: "Products"
}
"""Represents digital content associated with a product variant."""
-type DigitalContent implements Node & ObjectWithMetadata @doc(category: "Products") {
+type DigitalContent implements Node & ObjectWithMetadata {
"""The ID of the digital content."""
id: ID!
@@ -8104,7 +9637,7 @@ type DigitalContent implements Node & ObjectWithMetadata @doc(category: "Product
}
"""Represents a URL for digital content."""
-type DigitalContentUrl implements Node @doc(category: "Products") {
+type DigitalContentUrl implements Node {
"""The ID of the digital content URL."""
id: ID!
@@ -8127,7 +9660,7 @@ type DigitalContentUrl implements Node @doc(category: "Products") {
scalar UUID
"""Represents stock."""
-type Stock implements Node @doc(category: "Products") {
+type Stock implements Node {
"""The ID of stock."""
id: ID!
@@ -8160,7 +9693,7 @@ type Stock implements Node @doc(category: "Products") {
}
"""Represents preorder settings for product variant."""
-type PreorderData @doc(category: "Products") {
+type PreorderData {
"""
The global preorder threshold for product variant.
@@ -8180,7 +9713,7 @@ type PreorderData @doc(category: "Products") {
}
"""Represents availability of a product in the storefront."""
-type ProductPricingInfo @doc(category: "Products") {
+type ProductPricingInfo {
"""Whether it is in sale or not."""
onSale: Boolean
@@ -8229,7 +9762,7 @@ type TaxedMoneyRange {
}
"""Represents product channel listing."""
-type ProductChannelListing implements Node @doc(category: "Products") {
+type ProductChannelListing implements Node {
"""The ID of the product channel listing."""
id: ID!
publicationDate: Date @deprecated(reason: "Use the `publishedAt` field to fetch the publication date.")
@@ -8284,7 +9817,7 @@ type ProductChannelListing implements Node @doc(category: "Products") {
}
"""Metadata for the Margin class."""
-type Margin @doc(category: "Products") {
+type Margin {
"""The starting value of the margin."""
start: Int
@@ -8292,7 +9825,7 @@ type Margin @doc(category: "Products") {
stop: Int
}
-type ProductVariantCountableConnection @doc(category: "Products") {
+type ProductVariantCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [ProductVariantCountableEdge!]!
@@ -8301,7 +9834,7 @@ type ProductVariantCountableConnection @doc(category: "Products") {
totalCount: Int
}
-type ProductVariantCountableEdge @doc(category: "Products") {
+type ProductVariantCountableEdge {
"""The item at the end of the edge."""
node: ProductVariant!
@@ -8309,7 +9842,7 @@ type ProductVariantCountableEdge @doc(category: "Products") {
cursor: String!
}
-input ProductVariantFilterInput @doc(category: "Products") {
+input ProductVariantFilterInput {
search: String
sku: [String!]
metadata: [MetadataFilter!]
@@ -8317,7 +9850,7 @@ input ProductVariantFilterInput @doc(category: "Products") {
updatedAt: DateTimeRangeInput
}
-input ProductVariantWhereInput @doc(category: "Products") {
+input ProductVariantWhereInput {
metadata: [MetadataFilter!]
ids: [ID!]
@@ -8351,7 +9884,7 @@ input AssignedAttributeWhereInput {
value: AssignedAttributeValueInput
}
-input ProductVariantSortingInput @doc(category: "Products") {
+input ProductVariantSortingInput {
"""Specifies the direction in which to sort productVariants."""
direction: OrderDirection!
@@ -8359,12 +9892,12 @@ input ProductVariantSortingInput @doc(category: "Products") {
field: ProductVariantSortField!
}
-enum ProductVariantSortField @doc(category: "Products") {
+enum ProductVariantSortField {
"""Sort product variants by last modification date."""
LAST_MODIFIED_AT
}
-input MediaSortingInput @doc(category: "Products") {
+input MediaSortingInput {
"""Specifies the direction in which to sort media."""
direction: OrderDirection!
@@ -8372,13 +9905,13 @@ input MediaSortingInput @doc(category: "Products") {
field: MediaChoicesSortField!
}
-enum MediaChoicesSortField @doc(category: "Products") {
+enum MediaChoicesSortField {
"""Sort media by ID."""
ID
}
"""Represents a collection of products."""
-type Collection implements Node & ObjectWithMetadata @doc(category: "Products") {
+type Collection implements Node & ObjectWithMetadata {
"""The ID of the collection."""
id: ID!
@@ -8445,8 +9978,12 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products")
"""List of products in this collection."""
products(
- """Filtering options for products."""
- filter: ProductFilterInput @deprecated(reason: "Use `where` filter instead.")
+ """
+ Filtering options for products.
+
+ DEPRECATED: this field will be removed. Use `where` filter instead.
+ """
+ filter: ProductFilterInput
"""Where filtering options for products."""
where: ProductWhereInput
@@ -8484,7 +10021,7 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products")
"""
The format of the image. When not provided, format of the original image will be used.
"""
- format: ThumbnailFormatEnum = ORIGINAL
+ format: ThumbnailFormatEnum
): Image
"""Returns translated collection fields for the given language code."""
@@ -8502,7 +10039,7 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products")
}
"""Represents collection translations."""
-type CollectionTranslation implements Node @doc(category: "Products") {
+type CollectionTranslation implements Node {
"""The ID of the collection translation."""
id: ID!
@@ -8546,7 +10083,7 @@ type CollectionTranslation implements Node @doc(category: "Products") {
"""
Represents collection's original translatable fields and related translations.
"""
-type CollectionTranslatableContent implements Node @doc(category: "Products") {
+type CollectionTranslatableContent implements Node {
"""The ID of the collection translatable content."""
id: ID!
@@ -8594,7 +10131,7 @@ type CollectionTranslatableContent implements Node @doc(category: "Products") {
}
"""Represents collection channel listing."""
-type CollectionChannelListing implements Node @doc(category: "Products") {
+type CollectionChannelListing implements Node {
"""The ID of the collection channel listing."""
id: ID!
publicationDate: Date @deprecated(reason: "Use the `publishedAt` field to fetch the publication date.")
@@ -8610,7 +10147,7 @@ type CollectionChannelListing implements Node @doc(category: "Products") {
}
"""Represents product translations."""
-type ProductTranslation implements Node @doc(category: "Products") {
+type ProductTranslation implements Node {
"""The ID of the product translation."""
id: ID!
@@ -8654,7 +10191,7 @@ type ProductTranslation implements Node @doc(category: "Products") {
"""
Represents product's original translatable fields and related translations.
"""
-type ProductTranslatableContent implements Node @doc(category: "Products") {
+type ProductTranslatableContent implements Node {
"""The ID of the product translatable content."""
id: ID!
@@ -8704,7 +10241,7 @@ type ProductTranslatableContent implements Node @doc(category: "Products") {
attributeValues: [AttributeValueTranslatableContent!]!
}
-type StockCountableConnection @doc(category: "Products") {
+type StockCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [StockCountableEdge!]!
@@ -8713,7 +10250,7 @@ type StockCountableConnection @doc(category: "Products") {
totalCount: Int
}
-type StockCountableEdge @doc(category: "Products") {
+type StockCountableEdge {
"""The item at the end of the edge."""
node: Stock!
@@ -8721,167 +10258,260 @@ type StockCountableEdge @doc(category: "Products") {
cursor: String!
}
-type WarehouseCountableConnection @doc(category: "Products") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [WarehouseCountableEdge!]!
+"""List of shipping methods available for the country."""
+type ShippingMethodsPerCountry {
+ """The country code."""
+ countryCode: CountryCode!
- """A total count of items in the collection."""
- totalCount: Int
+ """List of available shipping methods."""
+ shippingMethods: [ShippingMethod!]
}
-type WarehouseCountableEdge @doc(category: "Products") {
- """The item at the end of the edge."""
- node: Warehouse!
+"""
+Shipping methods that can be used as means of shipping for orders and checkouts.
+"""
+type ShippingMethod implements Node & ObjectWithMetadata {
+ """Unique ID of ShippingMethod available for Order."""
+ id: ID!
- """A cursor for use in pagination."""
- cursor: String!
-}
+ """List of private metadata items. Requires staff permissions to access."""
+ privateMetadata: [MetadataItem!]!
-input WarehouseFilterInput @doc(category: "Products") {
- clickAndCollectOption: WarehouseClickAndCollectOptionEnum
- metadata: [MetadataFilter!]
- search: String
- ids: [ID!]
- isPrivate: Boolean
- channels: [ID!]
- slugs: [String!]
-}
+ """
+ A single key from private metadata. Requires staff permissions to access.
+
+ Tip: Use GraphQL aliases to fetch multiple keys.
+ """
+ privateMetafield(key: String!): String
-input WarehouseSortingInput @doc(category: "Products") {
- """Specifies the direction in which to sort warehouses."""
- direction: OrderDirection!
+ """
+ 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
- """Sort warehouses by the selected field."""
- field: WarehouseSortField!
-}
+ """List of public metadata items. Can be accessed without permissions."""
+ metadata: [MetadataItem!]!
-enum WarehouseSortField @doc(category: "Products") {
- """Sort warehouses by name."""
- NAME
-}
+ """
+ A single key from public metadata.
+
+ Tip: Use GraphQL aliases to fetch multiple keys.
+ """
+ metafield(key: String!): String
-type TranslatableItemConnection {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [TranslatableItemEdge!]!
+ """
+ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
+ """
+ metafields(keys: [String!]): Metadata
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """Type of the shipping method."""
+ type: ShippingMethodTypeEnum @deprecated
-type TranslatableItemEdge {
- """The item at the end of the edge."""
- node: TranslatableItem!
+ """Shipping method name."""
+ name: String!
- """A cursor for use in pagination."""
- cursor: 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
+
+ """Minimum order weight for this shipping method."""
+ minimumOrderWeight: Weight @deprecated
+
+ """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
}
-union TranslatableItem = ProductTranslatableContent | CollectionTranslatableContent | CategoryTranslatableContent | AttributeTranslatableContent | AttributeValueTranslatableContent | ProductVariantTranslatableContent | PageTranslatableContent | ShippingMethodTranslatableContent | VoucherTranslatableContent | MenuItemTranslatableContent | PromotionTranslatableContent | PromotionRuleTranslatableContent | SaleTranslatableContent
+"""Represents the channel stock settings."""
+type StockSettings {
+ """
+ Allocation strategy defines the preference of warehouses for allocations and reservations.
+ """
+ allocationStrategy: AllocationStrategyEnum!
+}
-"""
-Represents page's original translatable fields and related translations.
-"""
-type PageTranslatableContent implements Node @doc(category: "Pages") {
- """The ID of the page translatable content."""
- id: ID!
+"Determine the allocation strategy for the channel.\n\n PRIORITIZE_SORTING_ORDER - allocate stocks according to the warehouses' order\n within the channel\n\n PRIORITIZE_HIGH_STOCK - allocate stock in a warehouse with the most stock\n "
+enum AllocationStrategyEnum {
+ PRIORITIZE_SORTING_ORDER
+ PRIORITIZE_HIGH_STOCK
+}
- """The ID of the page to translate."""
- pageId: ID!
+"""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!
- """SEO title to translate."""
- seoTitle: String
+ """
+ When enabled, all non-shippable gift card orders will be fulfilled automatically.
+ """
+ automaticallyFulfillNonShippableGiftCard: Boolean!
- """SEO description to translate."""
- seoDescription: String
+ """
+ Expiration time in minutes. Default null - means do not expire any orders.
+ """
+ expireOrdersAfter: Minute
"""
- Slug to translate.
-
- Added in Saleor 3.21.
+ 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.
"""
- slug: String
+ markAsPaidStrategy: MarkAsPaidStrategyEnum!
- """Page title to translate."""
- title: String!
+ """The time in days after expired orders will be deleted."""
+ deleteExpiredOrdersAfter: Day!
"""
- Content of the page to translate.
-
- Rich text format. For reference see https://editorjs.io/
+ Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation.
"""
- content: JSONString
+ allowUnpaidOrders: Boolean!
"""
- Content of the page.
+ Determine if voucher applied on draft order should be count toward voucher usage.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.18.
+
+ Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
- contentJson: JSONString @deprecated(reason: "Use the `content` field instead.")
+ includeDraftOrderInVoucherUsage: Boolean!
- """Returns translated page fields for the given language code."""
- translation(
- """A language code to return the translation for page."""
- languageCode: LanguageCodeEnum!
- ): PageTranslation
+ """
+ Time in hours after which the draft order line price will be refreshed.
+
+ Added in Saleor 3.21.
+
+ Note: this API is currently in Feature Preview and can be subject to changes at later point.
+ """
+ draftOrderLinePriceFreezePeriod: Hour
"""
- A static page that can be manually added by a shop operator through the dashboard.
+ This flag only affects orders created from checkout and applies specifically to vouchers of the types: `SPECIFIC_PRODUCT` and `ENTIRE_ORDER` with `applyOncePerOrder` enabled.
+ - When legacy propagation is enabled, discounts from these vouchers are represented as `OrderDiscount` objects, attached to the order and returned in the `Order.discounts` field. Additionally, percentage-based vouchers are converted to fixed-value discounts.
+ - When legacy propagation is disabled, discounts are represented as `OrderLineDiscount` objects, attached to individual lines and returned in the `OrderLine.discounts` field. In this case, percentage-based vouchers retain their original type.
+ In future releases, `OrderLineDiscount` will become the default behavior, and this flag will be deprecated and removed.
+
+ Added in Saleor 3.21.
"""
- page: Page @deprecated(reason: "Get model fields from the root level queries.")
+ useLegacyLineDiscountPropagation: Boolean!
+}
- """List of page content attribute values that can be translated."""
- attributeValues: [AttributeValueTranslatableContent!]!
+"""
+The `Minute` scalar type represents number of minutes by integer value.
+"""
+scalar Minute
+
+"Determine the mark as paid strategy for the channel.\n\n TRANSACTION_FLOW - new orders marked as paid will receive a\n `TransactionItem` object, that will cover the `order.total`.\n\n PAYMENT_FLOW - new orders marked as paid will receive a\n `Payment` object, that will cover the `order.total`.\n\n "
+enum MarkAsPaidStrategyEnum {
+ TRANSACTION_FLOW
+ PAYMENT_FLOW
}
-"""Represents page translations."""
-type PageTranslation implements Node @doc(category: "Pages") {
- """The ID of the page translation."""
- id: ID!
+"""The `Day` scalar type represents number of days by integer value."""
+scalar Day
- """Translation language."""
- language: LanguageDisplay!
+"""The `Hour` scalar type represents number of hours by integer value."""
+scalar Hour
- """Translated SEO title."""
- seoTitle: String
+"""Represents the channel-specific checkout settings."""
+type CheckoutSettings {
+ """
+ Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
+
+ DEPRECATED: this field will be removed.
+ """
+ useLegacyErrorFlow: Boolean!
- """Translated SEO description."""
- seoDescription: String
+ """
+ Default `false`. Determines if the paid checkouts should be automatically completed. This setting applies only to checkouts where payment was processed through transactions.When enabled, the checkout will be automatically completed once the checkout `charge_status` reaches `FULL`. This occurs when the total sum of charged and authorized transaction amounts equals or exceeds the checkout's total amount.
+
+ Added in Saleor 3.20.
+ """
+ automaticallyCompleteFullyPaidCheckouts: Boolean!
"""
- Translated page slug.
+ The time in minutes to wait after a checkout is fully paid before automatically completing it.
- Added in Saleor 3.21.
+ Added in Saleor 3.22.
"""
- slug: String
+ automaticCompletionDelay: Minute
- """Translated page title."""
- title: String
+ """
+ The date time defines the earliest checkout creation date on which fully paid checkouts can begin to be automatically completed.
+
+ Added in Saleor 3.22.
+ """
+ automaticCompletionCutOffDate: DateTime
+}
+"""Represents the channel-specific payment settings."""
+type PaymentSettings {
"""
- Translated content of the page.
+ 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.
+ """
+ defaultTransactionFlowStrategy: TransactionFlowStrategyEnum!
+
+ """
+ Determine if the funds for expired checkouts should be released automatically.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.20.
"""
- content: JSONString
+ releaseFundsForExpiredCheckouts: Boolean
"""
- Translated description of the page.
+ The time in hours after which funds for expired checkouts will be released.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.20.
"""
- contentJson: JSONString @deprecated(reason: "Use the `content` field instead.")
+ checkoutTtlBeforeReleasingFunds: Hour
- """Represents the page fields to translate."""
- translatableContent: PageTranslatableContent
+ """
+ Specifies the earliest date on which funds for expired checkouts can begin to be released. Expired checkouts dated before this cut-off will not have their funds released. Additionally, no funds will be released for checkouts that are more than one year old, regardless of the cut-off date.
+
+ Added in Saleor 3.20.
+ """
+ checkoutReleaseFundsCutOffDate: DateTime
}
-"""
-A static page that can be manually added by a shop operator through the dashboard.
-"""
-type Page implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(category: "Pages") {
- """ID of the page."""
+"Determine the transaction flow strategy.\n\n AUTHORIZATION - the processed transaction should be only authorized\n CHARGE - the processed transaction should be charged.\n "
+enum TransactionFlowStrategyEnum {
+ AUTHORIZATION
+ CHARGE
+}
+
+"""Channel-specific tax configuration."""
+type TaxConfiguration implements Node & ObjectWithMetadata {
+ """The ID of the object."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -8914,127 +10544,83 @@ type Page implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(categ
"""
metafields(keys: [String!]): Metadata
- """
- Get a single attribute attached to page by attribute slug.
-
- Added in Saleor 3.22.
- """
- assignedAttribute(
- """Slug of the attribute"""
- slug: String!
- ): AssignedAttribute
+ """A channel to which the tax configuration applies to."""
+ channel: Channel!
+
+ """Determines whether taxes are charged in the given channel."""
+ chargeTaxes: Boolean!
"""
- List of attributes assigned to this page.
-
- Added in Saleor 3.22.
+ 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.
"""
- assignedAttributes(
- """Maximum number of attributes to return. Default is 100."""
- limit: PositiveInt = 100
- ): [AssignedAttribute!]!
+ taxCalculationStrategy: TaxCalculationStrategy
- """Title of the page for SEO."""
- seoTitle: String
+ """Determines whether displayed prices should include taxes."""
+ displayGrossPrices: Boolean!
- """Description of the page for SEO."""
- seoDescription: String
+ """Determines whether prices are entered with the tax included."""
+ pricesEnteredWithTax: Boolean!
- """Title of the page."""
- title: String!
+ """List of country-specific exceptions in tax configuration."""
+ countries: [TaxConfigurationPerCountry!]!
"""
- Content of the page.
+ The tax app `App.identifier` that will be used to calculate the taxes for the given channel. Empty value for `TAX_APP` set as `taxCalculationStrategy` means that Saleor will iterate over all installed tax apps. If multiple tax apps exist with provided tax app id use the `App` with newest `created` date. Will become mandatory in 4.0 for `TAX_APP` `taxCalculationStrategy`.
- Rich text format. For reference see https://editorjs.io/
- """
- content: JSONString
- publicationDate: Date @deprecated(reason: "Use the `publishedAt` field to fetch the publication date.")
-
- """The page publication date."""
- publishedAt: DateTime
-
- """Determines if the page is published."""
- isPublished: Boolean!
-
- """Slug of the page."""
- slug: String!
-
- """Determines the type of page"""
- pageType: PageType!
-
- """Date and time at which page was created."""
- created: DateTime!
+ Added in Saleor 3.19.
+ """
+ taxAppId: String
"""
- Content of the page.
+ Determines whether to use weighted tax for shipping. When set to true, the tax rate for shipping will be calculated based on the weighted average of tax rates from the order or checkout lines.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.21.
"""
- contentJson: JSONString! @deprecated(reason: "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
-
- """Get a single attribute attached to page by attribute slug."""
- attribute(
- """Slug of the attribute"""
- slug: String!
- ): SelectedAttribute @deprecated(reason: "Use `assignedAttribute` field instead.")
+ useWeightedTaxForShipping: Boolean
+}
- """List of attributes assigned to this page."""
- attributes: [SelectedAttribute!]! @deprecated(reason: "Use `assignedAttributes` field instead.")
+enum TaxCalculationStrategy {
+ FLAT_RATES
+ TAX_APP
}
-"""
-Represents voucher's original translatable fields and related translations.
-"""
-type VoucherTranslatableContent implements Node @doc(category: "Discounts") {
- """The ID of the voucher translatable content."""
- id: ID!
+"""Country-specific exceptions of a channel's tax configuration."""
+type TaxConfigurationPerCountry {
+ """Country in which this configuration applies."""
+ country: CountryDisplay!
- """The ID of the voucher to translate."""
- voucherId: ID!
+ """Determines whether taxes are charged in this country."""
+ chargeTaxes: Boolean!
- """Voucher name to translate."""
- name: String
+ """
+ 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
- """Returns translated voucher fields for the given language code."""
- translation(
- """A language code to return the translation for voucher."""
- languageCode: LanguageCodeEnum!
- ): VoucherTranslation
+ """
+ Determines whether displayed prices should include taxes for this country.
+ """
+ displayGrossPrices: Boolean!
"""
- Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes.
+ The tax app `App.identifier` that will be used to calculate the taxes for the given channel and country. If not provided, use the value from the channel's tax configuration.
- Requires one of the following permissions: MANAGE_DISCOUNTS.
+ Added in Saleor 3.19.
"""
- voucher: Voucher @deprecated(reason: "Get model fields from the root level queries.")
-}
-
-"""Represents voucher translations."""
-type VoucherTranslation implements Node @doc(category: "Discounts") {
- """The ID of the voucher translation."""
- id: ID!
-
- """Translation language."""
- language: LanguageDisplay!
-
- """Translated voucher name."""
- name: String
+ taxAppId: String
- """Represents the voucher fields to translate."""
- translatableContent: VoucherTranslatableContent
+ """
+ Determines whether to use weighted tax for shipping. When set to true, the tax rate for shipping will be calculated based on the weighted average of tax rates from the order or checkout lines.
+
+ Added in Saleor 3.21.
+ """
+ useWeightedTaxForShipping: Boolean
}
"""
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") {
+type Voucher implements Node & ObjectWithMetadata {
"""The ID of the voucher."""
id: ID!
@@ -9094,7 +10680,11 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") {
last: Int
): VoucherCodeCountableConnection
- """The code of the voucher."""
+ """
+ The code of the voucher.
+
+ DEPRECATED: this field will be removed.
+ """
code: String
"""The number of times a voucher can be used."""
@@ -9234,159 +10824,646 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") {
"""Determines a type of discount for voucher - value or percentage"""
discountValueType: DiscountValueTypeEnum!
- """Voucher value."""
- discountValue: Float
+ """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!]
+}
+
+type VoucherCodeCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [VoucherCodeCountableEdge!]!
+
+ """A total count of items in the collection."""
+ totalCount: Int
+}
+
+type VoucherCodeCountableEdge {
+ """The item at the end of the edge."""
+ node: VoucherCode!
+
+ """A cursor for use in pagination."""
+ cursor: String!
+}
+
+"""
+Represents voucher code.
+
+Added in Saleor 3.18.
+
+Note: this API is currently in Feature Preview and can be subject to changes at later point.
+"""
+type VoucherCode {
+ """The ID of the voucher code."""
+ id: ID!
+
+ """Code to use the voucher."""
+ code: String
+
+ """Number of times a code has been used."""
+ used: Int
+
+ """Whether a code is active or not."""
+ isActive: Boolean
+
+ """Date time of code creation."""
+ createdAt: DateTime!
+}
+
+"""Represents a connection to a list of collections."""
+type CollectionCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [CollectionCountableEdge!]!
+
+ """A total count of items in the collection."""
+ totalCount: Int
+}
+
+type CollectionCountableEdge {
+ """The item at the end of the edge."""
+ node: Collection!
+
+ """A cursor for use in pagination."""
+ cursor: String!
+}
+
+"""Represents voucher translations."""
+type VoucherTranslation implements Node {
+ """The ID of the voucher translation."""
+ id: ID!
+
+ """Translation language."""
+ language: LanguageDisplay!
+
+ """Translated voucher name."""
+ name: String
+
+ """Represents the voucher fields to translate."""
+ translatableContent: VoucherTranslatableContent
+}
+
+"""
+Represents voucher's original translatable fields and related translations.
+"""
+type VoucherTranslatableContent implements Node {
+ """The ID of the voucher translatable content."""
+ id: ID!
+
+ """The ID of the voucher to translate."""
+ voucherId: ID!
+
+ """Voucher name to translate."""
+ 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: "Get model fields from the root level queries.")
+}
+
+enum DiscountValueTypeEnum {
+ FIXED
+ PERCENTAGE
+}
+
+enum VoucherTypeEnum {
+ SHIPPING
+ ENTIRE_ORDER
+ SPECIFIC_PRODUCT
+}
+
+"""Represents voucher channel listing."""
+type VoucherChannelListing implements Node {
+ """The ID of channel listing."""
+ id: ID!
+
+ """The channel in which voucher can be applied."""
+ channel: Channel!
+
+ """The value of the discount on voucher in a channel."""
+ discountValue: Float!
+
+ """Currency code for voucher in a channel."""
+ currency: String!
+
+ """Minimum order value for voucher to apply in channel."""
+ minSpent: Money
+}
+
+"""
+Available payment gateway backend with configuration necessary to setup client.
+"""
+type PaymentGateway {
+ """Payment gateway name."""
+ name: String!
+
+ """Payment gateway ID."""
+ id: ID!
+
+ """Payment gateway client configuration."""
+ config: [GatewayConfigLine!]!
+
+ """Payment gateway supported currencies."""
+ currencies: [String!]!
+}
+
+"""Payment gateway client configuration key and value pair."""
+type GatewayConfigLine {
+ """Gateway config key."""
+ field: String!
+
+ """Gateway config value for key."""
+ value: String
+}
+
+"""
+A gift card is a prepaid electronic payment card accepted in stores. They can be used during checkout by providing a valid gift card codes.
+"""
+type GiftCard implements Node & ObjectWithMetadata {
+ """ID of the gift card."""
+ 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
+
+ """Code in format which allows displaying in a user interface."""
+ displayCode: String!
+
+ """Last 4 characters of gift card code."""
+ last4CodeChars: String!
+
+ """
+ Gift card code. It can be fetched both by a staff member with 'MANAGE_GIFT_CARD' when gift card hasn't been used yet or a user who bought or issued the gift card.
+
+ Requires one of the following permissions: MANAGE_GIFT_CARD, OWNER.
+ """
+ code: String!
+
+ """Date and time when gift card was created."""
+ created: DateTime!
+
+ """The user who bought or issued a gift card."""
+ createdBy: User
+
+ """The customer who used a gift card."""
+ usedBy: User @deprecated
+
+ """
+ Email address of the user who bought or issued gift card.
+
+ Requires one of the following permissions: MANAGE_USERS, OWNER.
+ """
+ createdByEmail: String
+
+ """Email address of the customer who used a gift card."""
+ usedByEmail: String @deprecated
+
+ """Date and time when gift card was last used."""
+ lastUsedOn: DateTime
+
+ """Expiry date of the gift card."""
+ expiryDate: Date
+
+ """
+ App which created the gift card.
+
+ Requires one of the following permissions: MANAGE_APPS, OWNER.
+ """
+ app: App
+
+ """Related gift card product."""
+ product: Product
+
+ """
+ List of events associated with the gift card.
+
+ Requires one of the following permissions: MANAGE_GIFT_CARD.
+ """
+ events(
+ """Filtering options for gift card events."""
+ filter: GiftCardEventFilterInput
+ ): [GiftCardEvent!]!
+
+ """
+ The gift card tag.
+
+ Requires one of the following permissions: MANAGE_GIFT_CARD.
+ """
+ tags: [GiftCardTag!]!
+
+ """Slug of the channel where the gift card was bought."""
+ boughtInChannel: String
+ isActive: Boolean!
+ initialBalance: Money!
+ currentBalance: Money!
+
+ """The customer who bought a gift card."""
+ user: User @deprecated(reason: "Use `createdBy` field instead.")
+
+ """End date of gift card."""
+ endDate: DateTime @deprecated(reason: "Use `expiryDate` field instead.")
+
+ """Start date of gift card."""
+ startDate: DateTime @deprecated
+}
+
+"""History log of the gift card."""
+type GiftCardEvent implements Node {
+ """ID of the event associated with a gift card."""
+ 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
+}
+
+enum GiftCardEventsEnum {
+ ISSUED
+ BOUGHT
+ UPDATED
+ ACTIVATED
+ DEACTIVATED
+ BALANCE_RESET
+ EXPIRY_DATE_UPDATED
+ TAGS_UPDATED
+ SENT_TO_CUSTOMER
+ RESENT
+ NOTE_ADDED
+ USED_IN_ORDER
+}
+
+type GiftCardEventBalance {
+ """Initial balance of the gift card."""
+ initialBalance: Money
+
+ """Current balance of the gift card."""
+ currentBalance: Money!
+
+ """Previous initial balance of the gift card."""
+ oldInitialBalance: Money
+
+ """Previous current balance of the gift card."""
+ oldCurrentBalance: Money
+}
+
+input GiftCardEventFilterInput {
+ type: GiftCardEventsEnum
+ orders: [ID!]
+}
+
+"""The gift card tag."""
+type GiftCardTag implements Node {
+ """ID of the tag associated with a gift card."""
+ id: ID!
+
+ """Name of the tag associated with a gift card."""
+ name: String!
+}
+
+"""Represents an item in the checkout."""
+type CheckoutLine implements Node & ObjectWithMetadata {
+ """The ID of the checkout line."""
+ 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
+
+ """The product variant from which the checkout line was created."""
+ variant: ProductVariant!
+
+ """The quantity of product variant assigned to the checkout line."""
+ quantity: Int!
+
+ """
+ The unit price of the checkout line, with taxes and discounts.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ unitPrice: TaxedMoney!
+
+ """The unit price of the checkout line, without discounts."""
+ undiscountedUnitPrice: Money!
+
+ """
+ The unit price of the checkout line prior to promotion.
+
+ Added in Saleor 3.21.
+ """
+ priorUnitPrice: Money
+
+ """
+ The sum of the checkout line price, taxes and discounts.
+
+ Triggers the following webhook events:
+ - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ """
+ totalPrice: TaxedMoney!
+
+ """The sum of the checkout line price, without discounts."""
+ undiscountedTotalPrice: Money!
- """Currency code for voucher."""
- currency: String
+ """
+ The sum of the checkout line price prior to promotion.
+
+ Added in Saleor 3.21.
+ """
+ priorTotalPrice: Money
- """Minimum order value to apply voucher."""
- minSpent: Money
+ """Indicates whether the item need to be delivered."""
+ requiresShipping: Boolean!
- """Determines a type of voucher."""
- type: VoucherTypeEnum!
+ """List of problems with the checkout line."""
+ problems: [CheckoutLineProblem!]
"""
- List of availability in channels for the voucher.
+ Determine if the line is a gift.
- Requires one of the following permissions: MANAGE_DISCOUNTS.
+ Added in Saleor 3.19.
+
+ Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
- channelListings: [VoucherChannelListing!]
+ isGift: Boolean
}
-type VoucherCodeCountableConnection @doc(category: "Discounts") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [VoucherCodeCountableEdge!]!
+"""Represents an problem in the checkout line."""
+union CheckoutLineProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable
- """A total count of items in the collection."""
- totalCount: Int
-}
+"""
+Indicates insufficient stock for a given checkout line.Placing the order will not be possible until solving this problem.
+"""
+type CheckoutLineProblemInsufficientStock {
+ """Available quantity of a variant."""
+ availableQuantity: Int
-type VoucherCodeCountableEdge @doc(category: "Discounts") {
- """The item at the end of the edge."""
- node: VoucherCode!
+ """The line that has variant with insufficient stock."""
+ line: CheckoutLine!
- """A cursor for use in pagination."""
- cursor: String!
+ """The variant with insufficient stock."""
+ variant: ProductVariant!
}
"""
-Represents voucher code.
-
-Added in Saleor 3.18.
+The variant assigned to the checkout line is not available.Placing the order will not be possible until solving this problem.
+"""
+type CheckoutLineProblemVariantNotAvailable {
+ """The line that has variant that is not available."""
+ line: CheckoutLine!
+}
-Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
-type VoucherCode {
- """The ID of the voucher code."""
+Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise.
+"""
+union DeliveryMethod = Warehouse | ShippingMethod
+
+"""Represents a payment transaction."""
+type TransactionItem implements Node & ObjectWithMetadata {
+ """The ID of the object."""
id: ID!
- """Code to use the voucher."""
- code: String
+ """List of private metadata items. Requires staff permissions to access."""
+ privateMetadata: [MetadataItem!]!
- """Number of times a code has been used."""
- used: Int
+ """
+ A single key from private metadata. Requires staff permissions to access.
+
+ Tip: Use GraphQL aliases to fetch multiple keys.
+ """
+ privateMetafield(key: String!): String
- """Whether a code is active or not."""
- isActive: Boolean
+ """
+ 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
- """Date time of code creation."""
- createdAt: DateTime!
-}
+ """List of public metadata items. Can be accessed without permissions."""
+ metadata: [MetadataItem!]!
-"""Represents a connection to a list of collections."""
-type CollectionCountableConnection @doc(category: "Products") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [CollectionCountableEdge!]!
+ """
+ A single key from public metadata.
+
+ Tip: Use GraphQL aliases to fetch multiple keys.
+ """
+ metafield(key: String!): String
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """
+ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
+ """
+ metafields(keys: [String!]): Metadata
-type CollectionCountableEdge @doc(category: "Products") {
- """The item at the end of the edge."""
- node: Collection!
+ """The transaction token."""
+ token: UUID!
- """A cursor for use in pagination."""
- cursor: String!
-}
+ """Date and time at which payment transaction was created."""
+ createdAt: DateTime!
-enum DiscountValueTypeEnum @doc(category: "Discounts") {
- FIXED
- PERCENTAGE
-}
+ """Date and time at which payment transaction was modified."""
+ modifiedAt: DateTime!
-enum VoucherTypeEnum @doc(category: "Discounts") {
- SHIPPING
- ENTIRE_ORDER
- SPECIFIC_PRODUCT
-}
+ """
+ List of actions that can be performed in the current state of a payment.
+ """
+ actions: [TransactionActionEnum!]!
-"""Represents voucher channel listing."""
-type VoucherChannelListing implements Node @doc(category: "Discounts") {
- """The ID of channel listing."""
- id: ID!
+ """Total amount authorized for this payment."""
+ authorizedAmount: Money!
- """The channel in which voucher can be applied."""
- channel: Channel!
+ """Total amount of ongoing authorization requests for the transaction."""
+ authorizePendingAmount: Money!
- """The value of the discount on voucher in a channel."""
- discountValue: Float!
+ """Total amount refunded for this payment."""
+ refundedAmount: Money!
- """Currency code for voucher in a channel."""
- currency: String!
+ """Total amount of ongoing refund requests for the transaction."""
+ refundPendingAmount: Money!
- """Minimum order value for voucher to apply in channel."""
- minSpent: Money
-}
+ """Total amount canceled for this payment."""
+ canceledAmount: Money!
-"""
-Represents menu item's original translatable fields and related translations.
-"""
-type MenuItemTranslatableContent implements Node @doc(category: "Menu") {
- """The ID of the menu item translatable content."""
- id: ID!
+ """Total amount of ongoing cancel requests for the transaction."""
+ cancelPendingAmount: Money!
- """The ID of the menu item to translate."""
- menuItemId: ID!
+ """Total amount charged for this payment."""
+ chargedAmount: Money!
- """Name of the menu item to translate."""
+ """Total amount of ongoing charge requests for the transaction."""
+ chargePendingAmount: Money!
+
+ """Name of the transaction."""
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
+ """Message related to the transaction."""
+ message: String!
+
+ """PSP reference of transaction."""
+ pspReference: String!
+
+ """The related order."""
+ order: Order
+
+ """The related checkout."""
+ checkout: Checkout
+
+ """List of all transaction's events."""
+ events: [TransactionEvent!]!
+
+ """User or App that created the transaction."""
+ createdBy: UserOrApp
"""
- Represents a single item of the related menu. Can store categories, collection or pages.
+ The url that will allow to redirect user to payment provider page with transaction details.
"""
- menuItem: MenuItem @deprecated(reason: "Get model fields from the root level queries.")
-}
+ externalUrl: String!
-"""Represents menu item translations."""
-type MenuItemTranslation implements Node @doc(category: "Menu") {
- """The ID of the menu item translation."""
- id: ID!
+ """
+ The payment method used for this transaction.
+
+ Added in Saleor 3.22.
+ """
+ paymentMethodDetails: PaymentMethodDetails
- """Translation language."""
- language: LanguageDisplay!
+ """
+ Reason of the refund.
+
+ Added in Saleor 3.22.
+ """
+ reason: String
- """Translated menu item name."""
- name: String!
+ """
+ Reason `Page` (Model) for refund.
+
+ Added in Saleor 3.22.
+ """
+ reasonReference: Page
+}
- """Represents the menu item fields to translate."""
- translatableContent: MenuItemTranslatableContent
+"Represents possible actions on payment transaction.\n\n The following actions are possible:\n CHARGE - Represents the charge action.\n REFUND - Represents a refund action.\n CANCEL - Represents a cancel action. Added in Saleor 3.12.\n "
+enum TransactionActionEnum {
+ CHARGE
+ REFUND
+ CANCEL
}
-"""
-Represents a single item of the related menu. Can store categories, collection or pages.
-"""
-type MenuItem implements Node & ObjectWithMetadata @doc(category: "Menu") {
- """The ID of the menu item."""
+"""Represents an order in the shop."""
+type Order implements Node & ObjectWithMetadata {
+ """ID of the order."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -9419,244 +11496,311 @@ type MenuItem implements Node & ObjectWithMetadata @doc(category: "Menu") {
"""
metafields(keys: [String!]): Metadata
- """The name of the menu item."""
- name: String!
+ """Date and time when the order was created."""
+ created: DateTime!
- """Represents the menu to which the menu item belongs."""
- menu: Menu!
+ """Date and time when the order was created."""
+ updatedAt: DateTime!
- """ID of parent menu item. If empty, menu will be top level menu."""
- parent: MenuItem
+ """Status of the order."""
+ status: OrderStatus!
- """Category associated with the menu item."""
- category: Category
+ """
+ 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, HANDLE_PAYMENTS, OWNER.
+ """
+ user: User
"""
- A collection associated with this menu item. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS.
+ Google Analytics tracking client ID.
+
+ DEPRECATED: this field will be removed.
"""
- collection: Collection
+ trackingClientId: String!
"""
- A page associated with this menu item. Requires one of the following permissions to include unpublished items: MANAGE_PAGES.
+ 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.
"""
- page: Page
+ billingAddress: Address
- """Indicates the position of the menu item within the menu structure."""
- level: Int!
+ """
+ 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
- """Represents the child items of the current menu item."""
- children: [MenuItem!]
+ """Method used for shipping."""
+ shippingMethodName: String
- """URL to the menu item."""
- url: String
+ """
+ Name of the collection point where the order should be picked up by the customer.
+ """
+ collectionPointName: 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
-}
+ """Channel through which the order was placed."""
+ channel: Channel!
-"""
-Represents a single menu - an object that is used to help navigate through the store.
-"""
-type Menu implements Node & ObjectWithMetadata @doc(category: "Menu") {
- """The ID of the menu."""
- id: ID!
+ """List of shipments for the order."""
+ fulfillments: [Fulfillment!]!
- """List of private metadata items. Requires staff permissions to access."""
- privateMetadata: [MetadataItem!]!
+ """List of order lines."""
+ lines: [OrderLine!]!
"""
- A single key from private metadata. Requires staff permissions to access.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
+ List of actions that can be performed in the current state of an order.
"""
- privateMetafield(key: String!): String
+ 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."""
+ availableCollectionPoints: [Warehouse!]!
"""
- Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
+ 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.
"""
- privateMetafields(keys: [String!]): Metadata
+ invoices: [Invoice!]!
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ """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."""
+ authorizeStatus: OrderAuthorizeStatusEnum!
+
+ """The charge status of the order."""
+ chargeStatus: OrderChargeStatusEnum!
+
+ """Returns True if order has to be exempt from taxes."""
+ taxExemption: Boolean!
"""
- A single key from public metadata.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
+ List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS.
"""
- metafield(key: String!): String
+ 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: "Use `deliveryMethod` instead.")
"""
- Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
+ Undiscounted total price of shipping.
+
+ Added in Saleor 3.19.
"""
- metafields(keys: [String!]): Metadata
+ undiscountedShippingPrice: Money!
- """The name of the menu."""
- name: String!
+ """Total price of shipping."""
+ shippingPrice: TaxedMoney!
- """Slug of the menu."""
- slug: String!
+ """The shipping tax rate value."""
+ shippingTaxRate: Float!
- """Menu items associated with this menu."""
- items: [MenuItem!]
-}
+ """
+ Denormalized tax class assigned to the shipping method.
+
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ """
+ shippingTaxClass: TaxClass
-"""
-Represents promotion's original translatable fields and related translations.
-"""
-type PromotionTranslatableContent implements Node @doc(category: "Discounts") {
- """ID of the promotion translatable content."""
- id: ID!
+ """Denormalized name of the tax class assigned to the shipping method."""
+ shippingTaxClassName: String
- """ID of the promotion to translate."""
- promotionId: ID!
+ """Denormalized public metadata of the shipping method's tax class."""
+ shippingTaxClassMetadata: [MetadataItem!]!
- """Name of the promotion."""
- name: String!
+ """
+ Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access.
+ """
+ shippingTaxClassPrivateMetadata: [MetadataItem!]!
+ token: String! @deprecated(reason: "Use `id` instead.")
+
+ """Voucher linked to the order."""
+ voucher: Voucher
"""
- Description of the promotion.
+ Voucher code that was used for Order.
- Rich text format. For reference see https://editorjs.io/
+ Added in Saleor 3.18.
"""
- description: JSONString
+ voucherCode: String
- """Returns translated promotion fields for the given language code."""
- translation(
- """A language code to return the translation for promotion."""
- languageCode: LanguageCodeEnum!
- ): PromotionTranslation
-}
+ """List of user gift cards."""
+ giftCards: [GiftCard!]!
-"""Represents promotion translations."""
-type PromotionTranslation implements Node @doc(category: "Discounts") {
- """ID of the promotion translation."""
- id: ID!
+ """Additional information provided by the customer about the order."""
+ customerNote: String!
- """Translation language."""
- language: LanguageDisplay!
+ """Weight of the order."""
+ weight: Weight!
- """Translated name of the promotion."""
- name: String
+ """URL to which user should be redirected after order is placed."""
+ redirectUrl: String
+
+ """The sum of line prices not including shipping."""
+ subtotal: TaxedMoney!
+
+ """User-friendly order status."""
+ statusDisplay: String!
"""
- Translated description of the promotion.
-
- Rich text format. For reference see https://editorjs.io/
+ Informs whether a draft order can be finalized(turned into a regular order).
"""
- description: JSONString
+ canFinalize: Boolean!
- """Represents the promotion fields to translate."""
- translatableContent: PromotionTranslatableContent
-}
+ """Amount authorized for the order."""
+ totalAuthorized: Money!
-"""
-Represents promotion rule's original translatable fields and related translations.
-"""
-type PromotionRuleTranslatableContent implements Node @doc(category: "Discounts") {
- """ID of the promotion rule translatable content."""
- id: ID!
+ """Amount captured for the order. """
+ totalCaptured: Money! @deprecated(reason: "Use `totalCharged` instead.")
- """ID of the promotion rule to translate."""
- promotionRuleId: ID!
+ """Amount charged for the order."""
+ totalCharged: Money!
- """Name of the promotion rule."""
- name: String
+ """Amount canceled for the order."""
+ totalCanceled: Money!
"""
- Description of the promotion rule.
+ List of events associated with the order.
- Rich text format. For reference see https://editorjs.io/
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- description: JSONString
+ events: [OrderEvent!]!
- """Returns translated promotion rule fields for the given language code."""
- translation(
- """A language code to return the translation for promotion rule."""
- languageCode: LanguageCodeEnum!
- ): PromotionRuleTranslation
-}
+ """The difference between the paid and the order total amount."""
+ totalBalance: Money!
-"""Represents promotion rule translations."""
-type PromotionRuleTranslation implements Node @doc(category: "Discounts") {
- """ID of the promotion rule translation."""
- id: ID!
+ """
+ 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
- """Translation language."""
- language: LanguageDisplay!
+ """Returns True, if order requires shipping."""
+ isShippingRequired: Boolean!
+
+ """The delivery method selected for this order."""
+ deliveryMethod: DeliveryMethod
+ languageCode: String! @deprecated(reason: "Use the `languageCodeEnum` field to fetch the language code.")
+
+ """Order language code."""
+ languageCodeEnum: LanguageCodeEnum!
+
+ """Returns applied discount."""
+ discount: Money @deprecated(reason: "Use the `discounts` field instead.")
+
+ """Discount name."""
+ discountName: String @deprecated(reason: "Use the `discounts` field instead.")
+
+ """Translated discount name."""
+ translatedDiscountName: String @deprecated(reason: "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 displayed prices should include taxes."""
+ displayGrossPrices: Boolean!
+
+ """External ID of this order."""
+ externalReference: String
- """Translated name of the promotion rule."""
- name: String
+ """ID of the checkout that the order was created from."""
+ checkoutId: ID
"""
- Translated description of the promotion rule.
+ List of granted refunds.
- Rich text format. For reference see https://editorjs.io/
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- description: JSONString
+ grantedRefunds: [OrderGrantedRefund!]!
- """Represents the promotion rule fields to translate."""
- translatableContent: PromotionRuleTranslatableContent
-}
+ """
+ Total amount of granted refund.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
+ """
+ totalGrantedRefund: Money!
-"""
-Represents sale's original translatable fields and related translations.
+ """Total refund amount for the order."""
+ totalRefunded: Money!
-DEPRECATED: this type will be removed. Use `PromotionTranslatableContent` instead.
-"""
-type SaleTranslatableContent implements Node @doc(category: "Discounts") {
- """The ID of the sale translatable content."""
- id: ID!
+ """
+ Total amount of ongoing refund requests for the order's transactions.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
+ """
+ totalRefundPending: Money!
- """The ID of the sale to translate."""
- saleId: ID!
+ """
+ Total amount of ongoing authorize requests for the order's transactions.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
+ """
+ totalAuthorizePending: Money!
- """Name of the sale to translate."""
- name: String!
+ """
+ Total amount of ongoing charge requests for the order's transactions.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
+ """
+ totalChargePending: Money!
- """Returns translated sale fields for the given language code."""
- translation(
- """A language code to return the translation for sale."""
- languageCode: LanguageCodeEnum!
- ): SaleTranslation
+ """
+ Total amount of ongoing cancel requests for the order's transactions.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
+ """
+ totalCancelPending: Money!
"""
- Sales allow creating discounts for categories, collections or products and are visible to all the customers.
+ The difference amount between granted refund and the amounts that are pending and refunded.
- Requires one of the following permissions: MANAGE_DISCOUNTS.
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- sale: Sale @deprecated(reason: "Get model fields from the root level queries.")
+ totalRemainingGrant: Money!
}
-"""
-Represents sale translations.
-
-DEPRECATED: this type will be removed. Use `PromotionTranslation` instead.
-"""
-type SaleTranslation implements Node @doc(category: "Discounts") {
- """The ID of the sale translation."""
- id: ID!
-
- """Translation language."""
- language: LanguageDisplay!
-
- """Translated name of sale."""
- name: String
-
- """Represents the sale fields to translate."""
- translatableContent: SaleTranslatableContent
+enum OrderStatus {
+ DRAFT
+ UNCONFIRMED
+ UNFULFILLED
+ PARTIALLY_FULFILLED
+ PARTIALLY_RETURNED
+ RETURNED
+ FULFILLED
+ CANCELED
+ EXPIRED
}
-"""
-Sales allow creating discounts for categories, collections or products and are visible to all the customers.
-
-DEPRECATED: this type will be removed. Use `Promotion` type instead.
-"""
-type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") {
- """The ID of the sale."""
+"""Represents order fulfillment."""
+type Fulfillment implements Node & ObjectWithMetadata {
+ """ID of the fulfillment."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -9689,248 +11833,89 @@ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") {
"""
metafields(keys: [String!]): Metadata
- """The name of the sale."""
- name: String!
-
- """Type of the sale, fixed or percentage."""
- type: SaleType!
+ """Sequence in which the fulfillments were created for an order."""
+ fulfillmentOrder: Int!
- """The start date and time of the sale."""
- startDate: DateTime!
+ """Status of fulfillment."""
+ status: FulfillmentStatus!
- """The end date and time of the sale."""
- endDate: DateTime
+ """Fulfillment tracking number."""
+ trackingNumber: String!
- """The date and time when the sale was created."""
+ """Date and time when fulfillment was created."""
created: DateTime!
- """The date and time when the sale was updated."""
- 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
+ """List of lines for the fulfillment."""
+ lines: [FulfillmentLine!]
- """
- 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
+ """User-friendly fulfillment status."""
+ statusDisplay: String
- """
- 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
+ """Warehouse from fulfillment was fulfilled."""
+ warehouse: Warehouse
"""
- List of collections this sale applies to.
+ Reason for the fulfillment action.
- Requires one of the following permissions: MANAGE_DISCOUNTS.
+ Added in Saleor 3.22.
"""
- 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
+ reason: String
"""
- List of products this sale applies to.
+ Reason Model (Page) reference for this fulfillment.
- Requires one of the following permissions: MANAGE_DISCOUNTS.
+ Added in Saleor 3.22.
"""
- 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
+ reasonReference: Page
- """
- 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
+ """Amount of refunded shipping price."""
+ shippingRefundedAmount: Money
- """
- List of product variants this sale applies to.
-
- Requires one of the following permissions: MANAGE_DISCOUNTS.
- """
- variants(
- """Return the elements in the list that come before the specified cursor."""
- before: String
+ """Total refunded amount assigned to this fulfillment."""
+ totalRefundedAmount: Money
+}
- """Return the elements in the list that come after the specified cursor."""
- after: String
+enum FulfillmentStatus {
+ FULFILLED
+ REFUNDED
+ RETURNED
+ REPLACED
+ REFUNDED_AND_RETURNED
+ CANCELED
+ WAITING_FOR_APPROVAL
+}
- """
- 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
+"""Represents line of the fulfillment."""
+type FulfillmentLine implements Node {
+ """ID of the fulfillment line."""
+ id: ID!
- """
- 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
+ """The number of items included in the fulfillment line."""
+ quantity: Int!
- """Returns translated sale fields for the given language code."""
- translation(
- """A language code to return the translation for sale."""
- languageCode: LanguageCodeEnum!
- ): SaleTranslation
+ """The order line to which the fulfillment line is related."""
+ orderLine: OrderLine
"""
- List of channels available for the sale.
+ Reason for the fulfillment line action.
- Requires one of the following permissions: MANAGE_DISCOUNTS.
+ Added in Saleor 3.22.
"""
- channelListings: [SaleChannelListing!]
-
- """Sale value."""
- discountValue: Float
-
- """Currency code for sale."""
- currency: String
-}
+ reason: String
-enum SaleType @doc(category: "Discounts") {
- FIXED
- PERCENTAGE
+ """
+ Reason Model (Page) reference for this fulfillment line.
+
+ Added in Saleor 3.22.
+ """
+ reasonReference: Page
}
-"""
-Represents sale channel listing.
-
-DEPRECATED: this type will be removed. Use `PromotionRule` type instead.
-"""
-type SaleChannelListing implements Node @doc(category: "Discounts") {
- """The ID of the channel listing."""
+"""Represents order line of particular order."""
+type OrderLine implements Node & ObjectWithMetadata {
+ """ID of the order line."""
id: ID!
- """The channel in which the sale is available."""
- channel: Channel!
-
- """The value of the discount applied to the sale in the channel."""
- discountValue: Float!
-
- """The currency in which the discount value is specified."""
- currency: String!
-}
-
-enum TranslatableKinds {
- ATTRIBUTE
- ATTRIBUTE_VALUE
- CATEGORY
- COLLECTION
- MENU_ITEM
- PAGE
- PRODUCT
- PROMOTION
- PROMOTION_RULE
- SALE
- SHIPPING_METHOD
- VARIANT
- VOUCHER
-}
-
-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."""
-type TaxCountryConfiguration @doc(category: "Taxes") {
- """A country for which tax class rates are grouped."""
- country: CountryDisplay!
-
- """List of tax class rates."""
- taxClassCountryRates: [TaxClassCountryRate!]!
-}
-
-input StockFilterInput @doc(category: "Products") {
- quantity: Float
- search: String
-}
-
-"""
-Represents a shop resource containing general shop data and configuration.
-"""
-type Shop implements ObjectWithMetadata {
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
@@ -9961,305 +11946,219 @@ type Shop implements ObjectWithMetadata {
"""
metafields(keys: [String!]): Metadata
- """ID of the shop."""
- id: ID!
-
- """List of available payment gateways."""
- availablePaymentGateways(
- """A currency for which gateways will be returned."""
- currency: String @deprecated(reason: "Use `channel` argument instead.")
+ """Name of the product in order line."""
+ productName: String!
- """Slug of a channel for which the data should be returned."""
- channel: String
- ): [PaymentGateway!]!
+ """Name of the variant of product in order line."""
+ variantName: String!
- """List of available external authentications."""
- availableExternalAuthentications: [ExternalAuthentication!]!
+ """SKU of the product variant."""
+ productSku: String
- """Shipping methods that are available for the shop."""
- availableShippingMethods(
- """Slug of a channel for which the data should be returned."""
- channel: String!
+ """The ID of the product variant."""
+ productVariantId: String
- """Address for which available shipping methods should be returned."""
- address: AddressInput
- ): [ShippingMethod!]
+ """Whether the product variant requires shipping."""
+ isShippingRequired: Boolean!
- """
- List of all currencies supported by shop's channels.
-
- Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
- """
- channelCurrencies: [String!]!
+ """Number of variant items ordered."""
+ quantity: Int!
- """List of countries available in the shop."""
- countries(
- """A language code to return the translation for."""
- languageCode: LanguageCodeEnum @deprecated
+ """Number of variant items fulfilled."""
+ quantityFulfilled: Int!
- """Filtering options for countries"""
- filter: CountryFilterInput
- ): [CountryDisplay!]!
+ """Rate of tax applied on product variant."""
+ 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
- """Shop's default country."""
- defaultCountry: CountryDisplay
+ """
+ The format of the image. When not provided, format of the original image will be used.
+ """
+ format: ThumbnailFormatEnum
+ ): Image
"""
- Default shop's email sender's name.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
+ Price of the single item in the order line with all the line-level discounts and order-level discount portions applied.
"""
- defaultMailSenderName: String
+ unitPrice: TaxedMoney!
"""
- Default shop's email sender's address.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
+ Price of the single item in the order line without any discount applied.
"""
- 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."""
- fulfillmentAutoApprove: Boolean!
-
- """Allow to approve fulfillments which are unpaid."""
- fulfillmentAllowUnpaid: Boolean!
+ undiscountedUnitPrice: TaxedMoney!
"""
- This field is used as a default value for `ProductVariant.trackInventory`.
+ Sum of the line-level discounts applied to the order line. Order-level discounts which affect the line are not visible in this field. For order-level discount portion (if any), please query `order.discounts` field.
"""
- 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
+ unitDiscount: Money!
"""
- Enable automatic fulfillment for all digital products.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
+ Reason for line-level discounts applied on the order line. Order-level discounts which affect the line are not visible in this field. For order-level discount reason (if any), please query `order.discounts` field.
"""
- automaticFulfillmentDigitalProducts: Boolean
+ unitDiscountReason: String
"""
- Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
+ Value of the discount. Can store fixed value or percent value. This field shouldn't be used when multiple discounts affect the line. There is a limitation, that after running `checkoutComplete` mutation the field always stores fixed value.
"""
- reserveStockDurationAnonymousUser: Int
+ unitDiscountValue: PositiveDecimal!
"""
- Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
+ Type of the discount: `fixed` or `percent`. This field shouldn't be used when multiple discounts affect the line. There is a limitation, that after running `checkoutComplete` mutation the field is always set to `fixed`.
"""
- reserveStockDurationAuthenticatedUser: Int
+ unitDiscountType: DiscountValueTypeEnum
- """
- Default number of maximum line quantity in single checkout (per single checkout line).
-
- Requires one of the following permissions: MANAGE_SETTINGS.
- """
- limitQuantityPerCheckout: Int
+ """Price of the order line."""
+ totalPrice: TaxedMoney!
- """
- Default number of max downloads per digital content URL.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
- """
- defaultDigitalMaxDownloads: Int
+ """Price of the order line without discounts."""
+ undiscountedTotalPrice: TaxedMoney!
+
+ """Returns True, if the line unit price was overridden."""
+ isPriceOverridden: Boolean
"""
- Default number of days which digital content URL will be valid.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
+ 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.
"""
- defaultDigitalUrlValidDays: Int
-
- """Company address."""
- companyAddress: Address
+ variant: ProductVariant
- """URL of a view where customers can set their password."""
- customerSetPasswordUrl: String
+ """Product name in the customer's language"""
+ translatedProductName: String!
- """
- List of staff notification recipients.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
- """
- staffNotificationRecipients: [StaffNotificationRecipient!]
+ """Variant name in the customer's language"""
+ translatedVariantName: String!
"""
- Determines if account confirmation by email is enabled.
+ List of allocations across warehouses.
- Requires one of the following permissions: MANAGE_SETTINGS.
+ Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
- enableAccountConfirmationByEmail: Boolean
+ allocations: [Allocation!]
"""
- Determines if user can login without confirmation when `enableAccountConfirmation` is enabled.
-
- Requires one of the following permissions: MANAGE_SETTINGS.
+ Denormalized sale ID, set when order line is created for a product variant that is on sale.
"""
- allowLoginWithoutConfirmation: Boolean
+ saleId: ID
+
+ """A quantity of items remaining to be fulfilled."""
+ quantityToFulfill: Int!
"""
- Resource limitations and current usage if any set for a shop
+ Denormalized tax class of the product in this order line.
- Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
"""
- limits: LimitInfo! @deprecated
+ taxClass: TaxClass
+
+ """Denormalized name of the tax class."""
+ taxClassName: String
+
+ """Denormalized public metadata of the tax class."""
+ taxClassMetadata: [MetadataItem!]!
"""
- Saleor API version.
-
- Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ Denormalized private metadata of the tax class. Requires staff permissions to access.
"""
- version: String!
+ taxClassPrivateMetadata: [MetadataItem!]!
- """Minor Saleor API version."""
- schemaVersion: String!
+ """Voucher code that was used for this order line."""
+ voucherCode: String
"""
- List of tax apps that can be assigned to the channel. The list will be calculated by Saleor based on the apps that are subscribed to webhooks related to tax calculations: CHECKOUT_CALCULATE_TAXES
+ Determine if the line is a gift.
Added in Saleor 3.19.
- Requires one of the following permissions: AUTHENTICATED_STAFF_USER, MANAGE_APPS.
+ Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
- availableTaxApps: [App!]!
-
- """Include taxes in prices."""
- includeTaxesInPrices: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax.")
-
- """Display prices with tax in store."""
- displayGrossPrices: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration` to determine whether to display gross or net prices.")
-
- """Charge taxes on shipping."""
- chargeTaxesOnShipping: Boolean! @deprecated(reason: "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.")
+ isGift: Boolean
"""
- Use legacy update webhook emission. When enabled, update webhooks (e.g. `customerUpdated`,`productVariantUpdated`) are sent even when only metadata changes. When disabled, update webhooks are not sent for metadata-only changes; only metadata-specific webhooks (e.g., `customerMetadataUpdated`, `productVariantMetadataUpdated`) are sent.
+ List of applied discounts
- Added in Saleor 3.22.
+ Added in Saleor 3.21.
"""
- useLegacyUpdateWebhookEmission: Boolean @deprecated
+ discounts: [OrderLineDiscount!]
}
"""
-Available payment gateway backend with configuration necessary to setup client.
+Nonnegative Decimal scalar implementation.
+
+Should be used in places where value must be nonnegative (0 or greater).
"""
-type PaymentGateway @doc(category: "Payments") {
- """Payment gateway name."""
- name: String!
+scalar PositiveDecimal
- """Payment gateway ID."""
+"""Represents allocation."""
+type Allocation implements Node {
+ """The ID of allocation."""
id: ID!
- """Payment gateway client configuration."""
- config: [GatewayConfigLine!]!
+ """
+ Quantity allocated for orders.
+
+ Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
+ """
+ quantity: Int!
- """Payment gateway supported currencies."""
- currencies: [String!]!
+ """
+ The warehouse were items were allocated.
+
+ Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
+ """
+ warehouse: Warehouse!
}
-"""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
-}
+"""Represent the discount applied to order line."""
+type OrderLineDiscount {
+ """The ID of discount applied."""
+ id: ID!
-"""External authentication plugin."""
-type ExternalAuthentication @doc(category: "Authentication") {
- """ID of external authentication plugin."""
- id: String!
+ """The type of applied discount: Sale, Voucher or Manual."""
+ type: OrderDiscountType!
- """Name of external authentication plugin."""
+ """The name of applied discount."""
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 API domain."""
-type Domain {
- """The host name of the domain."""
- host: String!
+ """Translated name of the applied discount."""
+ translatedName: String
- """Inform if SSL is enabled."""
- sslEnabled: Boolean!
+ """Type of the discount: fixed or percent"""
+ valueType: DiscountValueTypeEnum!
- """The absolute URL of the API."""
- url: String!
-}
+ """Value of the discount. Can store fixed value or percent value"""
+ value: PositiveDecimal!
-"""Represents shop translations."""
-type ShopTranslation implements Node @doc(category: "Shop") {
- """The ID of the shop translation."""
- id: ID!
+ """
+ Explanation for the applied discount.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
+ """
+ reason: String
- """Translation language."""
- language: LanguageDisplay!
+ """The discount amount applied to the line item."""
+ total: Money!
- """Translated header text of sale."""
- headerText: String!
+ """The discount amount applied to the single line unit."""
+ unit: Money!
+}
- """Translated description of sale."""
- description: String!
+enum OrderDiscountType {
+ SALE
+ VOUCHER
+ MANUAL
+ PROMOTION
+ ORDER_PROMOTION
}
"""
-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.
+A static page that can be manually added by a shop operator through the dashboard.
"""
-type StaffNotificationRecipient implements Node {
- """The ID of the staff notification recipient."""
- 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") {
- """The ID of the user."""
+type Page implements Node & ObjectWithMetadata & ObjectWithAttributes {
+ """ID of the page."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -10292,193 +12191,309 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") {
"""
metafields(keys: [String!]): Metadata
- """The email address of the user."""
- email: String!
+ """
+ Get a single attribute attached to page by attribute slug.
+
+ Added in Saleor 3.22.
+ """
+ assignedAttribute(
+ """Slug of the attribute"""
+ slug: String!
+ ): AssignedAttribute
- """The given name of the address."""
- firstName: String!
+ """
+ List of attributes assigned to this page.
+
+ Added in Saleor 3.22.
+ """
+ assignedAttributes(
+ """Maximum number of attributes to return. Default is 100."""
+ limit: PositiveInt = 100
+ ): [AssignedAttribute!]!
- """The family name of the address."""
- lastName: String!
+ """Title of the page for SEO."""
+ seoTitle: String
- """Determine if the user is a staff admin."""
- isStaff: Boolean!
+ """Description of the page for SEO."""
+ seoDescription: String
- """Determine if the user is active."""
- isActive: Boolean!
+ """Title of the page."""
+ title: String!
- """Determines if user has confirmed email."""
- isConfirmed: Boolean!
+ """
+ Content of the page.
+
+ Rich text format. For reference see https://editorjs.io/
+ """
+ content: JSONString
+ publicationDate: Date @deprecated(reason: "Use the `publishedAt` field to fetch the publication date.")
- """List of all user's addresses."""
- addresses: [Address!]!
+ """The page publication date."""
+ publishedAt: DateTime
- """Returns the last open checkout of this user."""
- checkout: Checkout @deprecated(reason: "Use the `checkoutTokens` field to fetch the user checkouts.")
+ """Determines if the page is published."""
+ isPublished: Boolean!
- """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: "Use `checkoutIds` instead.")
+ """Slug of the page."""
+ slug: String!
- """Returns the checkout ID's assigned to this user."""
- checkoutIds(
- """Slug of a channel for which the data should be returned."""
- channel: String
- ): [ID!]
+ """Determines the type of page"""
+ pageType: PageType!
+
+ """Date and time at which page was created."""
+ created: DateTime!
"""
- Returns checkouts assigned to this user. The query will not initiate any external requests, including fetching external shipping methods, filtering available shipping methods, or performing external tax calculations.
+ Content of the page.
+
+ Rich text format. For reference see https://editorjs.io/
"""
- checkouts(
- """Slug of a channel for which the data should be returned."""
- channel: String
+ contentJson: JSONString! @deprecated(reason: "Use the `content` field instead.")
- """Return the elements in the list that come before the specified cursor."""
- before: String
+ """Returns translated page fields for the given language code."""
+ translation(
+ """A language code to return the translation for page."""
+ languageCode: LanguageCodeEnum!
+ ): PageTranslation
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """Get a single attribute attached to page by attribute slug."""
+ attribute(
+ """Slug of the attribute"""
+ slug: String!
+ ): SelectedAttribute @deprecated(reason: "Use `assignedAttribute` field instead.")
- """
- 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
+ """List of attributes assigned to this page."""
+ attributes: [SelectedAttribute!]! @deprecated(reason: "Use `assignedAttributes` field instead.")
+}
- """
- 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
+"""Represents page translations."""
+type PageTranslation implements Node {
+ """The ID of the page translation."""
+ id: ID!
- """List of the user gift cards."""
- giftCards(
- """Return the elements in the list that come before the specified cursor."""
- before: String
+ """Translation language."""
+ language: LanguageDisplay!
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """Translated SEO title."""
+ seoTitle: 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
+ """Translated SEO description."""
+ seoDescription: String
- """
- 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
+ """
+ Translated page slug.
+
+ Added in Saleor 3.21.
+ """
+ slug: String
+
+ """Translated page title."""
+ title: String
"""
- A note about the customer.
+ Translated content of the page.
- Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.
+ Rich text format. For reference see https://editorjs.io/
"""
- note: String
+ content: JSONString
"""
- List of user's orders. The query will not initiate any external requests, including filtering available shipping methods, or performing external tax calculations. Requires one of the following permissions: MANAGE_STAFF, OWNER.
+ Translated description of the page.
+
+ Rich text format. For reference see https://editorjs.io/
"""
- orders(
- """Return the elements in the list that come before the specified cursor."""
- before: String
+ contentJson: JSONString @deprecated(reason: "Use the `content` field instead.")
- """Return the elements in the list that come after the specified cursor."""
- after: String
+ """Represents the page fields to translate."""
+ translatableContent: PageTranslatableContent
+}
- """
- 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
+"""
+Represents page's original translatable fields and related translations.
+"""
+type PageTranslatableContent implements Node {
+ """The ID of the page translatable content."""
+ id: ID!
- """
- 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
+ """The ID of the page to translate."""
+ pageId: ID!
- """List of user's permissions."""
- userPermissions: [UserPermission!]
+ """SEO title to translate."""
+ seoTitle: String
- """List of user's permission groups."""
- permissionGroups: [Group!]
+ """SEO description to translate."""
+ seoDescription: String
- """List of user's permission groups which user can manage."""
- editableGroups: [Group!]
+ """
+ Slug to translate.
+
+ Added in Saleor 3.21.
+ """
+ slug: String
+
+ """Page title to translate."""
+ title: String!
"""
- 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.
+ Content of the page to translate.
+
+ Rich text format. For reference see https://editorjs.io/
"""
- accessibleChannels: [Channel!]
+ content: JSONString
"""
- Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False.
+ Content of the page.
+
+ Rich text format. For reference see https://editorjs.io/
"""
- restrictedAccessToChannels: Boolean!
+ contentJson: JSONString @deprecated(reason: "Use the `content` field instead.")
- """The avatar of the user."""
- 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
+ """Returns translated page fields for the given language code."""
+ translation(
+ """A language code to return the translation for page."""
+ languageCode: LanguageCodeEnum!
+ ): PageTranslation
- """
- The format of the image. When not provided, format of the original image will be used.
- """
- format: ThumbnailFormatEnum = ORIGINAL
- ): Image
+ """
+ A static page that can be manually added by a shop operator through the dashboard.
+ """
+ page: Page @deprecated(reason: "Get model fields from the root level queries.")
+
+ """List of page content attribute values that can be translated."""
+ attributeValues: [AttributeValueTranslatableContent!]!
+}
+
+enum OrderAction {
+ """Represents the capture action."""
+ CAPTURE
+
+ """Represents a mark-as-paid action."""
+ MARK_AS_PAID
+
+ """Represents a refund action."""
+ REFUND
+
+ """Represents a void action."""
+ VOID
+}
+
+"""Represents an Invoice."""
+type Invoice implements ObjectWithMetadata & Job & Node {
+ """List of private metadata items. Requires staff permissions to access."""
+ privateMetadata: [MetadataItem!]!
"""
- List of events associated with the user.
+ A single key from private metadata. Requires staff permissions to access.
- Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF.
+ Tip: Use GraphQL aliases to fetch multiple keys.
"""
- events: [CustomerEvent!]
+ privateMetafield(key: String!): String
"""
- List of stored payment sources. The field returns a list of payment sources stored for payment plugins.
+ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
"""
- storedPaymentSources(
- """Slug of a channel for which the data should be returned."""
- channel: String
- ): [PaymentSource!]
+ privateMetafields(keys: [String!]): Metadata
- """User language code."""
- languageCode: LanguageCodeEnum!
+ """List of public metadata items. Can be accessed without permissions."""
+ metadata: [MetadataItem!]!
- """The default shipping address of the user."""
- defaultShippingAddress: Address
+ """
+ A single key from public metadata.
+
+ Tip: Use GraphQL aliases to fetch multiple keys.
+ """
+ metafield(key: String!): String
- """The default billing address of the user."""
- defaultBillingAddress: Address
+ """
+ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
+ """
+ metafields(keys: [String!]): Metadata
- """External ID of this user."""
- externalReference: String
+ """Job status."""
+ status: JobStatusEnum!
- """The date when the user last time log in to the system."""
- lastLogin: DateTime
+ """Date and time at which invoice was created."""
+ createdAt: DateTime!
- """The data when the user create account."""
- dateJoined: DateTime!
+ """Date and time at which invoice was updated."""
+ updatedAt: DateTime!
- """The data when the user last update the account information."""
+ """Message associated with an invoice."""
+ message: String
+
+ """The ID of the object."""
+ id: ID!
+
+ """Invoice number."""
+ number: String
+
+ """URL to view an invoice."""
+ externalUrl: String @deprecated(reason: "Use `url` field.")
+
+ """URL to view/download an invoice."""
+ url: String
+
+ """Order related to the invoice."""
+ 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!
- """
- Returns a list of user's stored payment methods that can be used in provided channel. The field returns a list of stored payment methods by payment apps. When `amount` is not provided, 0 will be used as default value.
- """
- storedPaymentMethods(
- """Slug of a channel for which the data should be returned."""
- channel: String!
- ): [StoredPaymentMethod!]
+ """Job message."""
+ message: String
+}
+
+enum JobStatusEnum {
+ PENDING
+ SUCCESS
+ FAILED
+ DELETED
+}
+
+enum OrderOriginEnum {
+ CHECKOUT
+ DRAFT
+ REISSUE
+ BULK_CREATE
+}
+
+enum PaymentChargeStatusEnum {
+ NOT_CHARGED
+ PENDING
+ PARTIALLY_CHARGED
+ FULLY_CHARGED
+ PARTIALLY_REFUNDED
+ FULLY_REFUNDED
+ REFUSED
+ CANCELLED
+}
+
+"Determine a current authorize status for order.\n\n We treat the order as fully authorized when the sum of authorized and charged funds\n cover the `order.total`-`order.totalGrantedRefund`.\n We treat the order as partially authorized when the sum of authorized and charged\n funds covers only part of the `order.total`-`order.totalGrantedRefund`.\n We treat the order as not authorized when the sum of authorized and charged funds is\n 0.\n\n NONE - the funds are not authorized\n PARTIAL - the funds that are authorized and charged don't cover fully the\n `order.total`-`order.totalGrantedRefund`\n FULL - the funds that are authorized and charged fully cover the\n `order.total`-`order.totalGrantedRefund`\n "
+enum OrderAuthorizeStatusEnum {
+ NONE
+ PARTIAL
+ FULL
+}
+
+"Determine the current charge status for the order.\n\n An order is considered overcharged when the sum of the\n transactionItem's charge amounts exceeds the value of\n `order.total` - `order.totalGrantedRefund`.\n If the sum of the transactionItem's charge amounts equals\n `order.total` - `order.totalGrantedRefund`, we consider the order to be fully\n charged.\n If the sum of the transactionItem's charge amounts covers a part of the\n `order.total` - `order.totalGrantedRefund`, we treat the order as partially charged.\n\n NONE - the funds are not charged.\n PARTIAL - the funds that are charged don't cover the\n `order.total`-`order.totalGrantedRefund`\n FULL - the funds that are charged fully cover the\n `order.total`-`order.totalGrantedRefund`\n OVERCHARGED - the charged funds are bigger than the\n `order.total`-`order.totalGrantedRefund`\n "
+enum OrderChargeStatusEnum {
+ NONE
+ PARTIAL
+ FULL
+ OVERCHARGED
}
-"""Checkout object."""
-type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") {
- """The ID of the checkout."""
+"""Represents a payment of a given type."""
+type Payment implements Node & ObjectWithMetadata {
+ """ID of the payment."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -10511,1012 +12526,1255 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") {
"""
metafields(keys: [String!]): Metadata
- """The date and time when the checkout was created."""
+ """Payment gateway used for payment."""
+ gateway: String!
+
+ """Determines if the payment is active or not."""
+ isActive: Boolean!
+
+ """Date and time at which payment was created."""
created: DateTime!
- """Time of last modification of the given checkout."""
- updatedAt: DateTime!
- lastChange: DateTime! @deprecated(reason: "Use `updatedAt` instead.")
+ """Date and time at which payment was modified."""
+ modified: DateTime!
- """
- The user assigned to the checkout. Requires one of the following permissions: MANAGE_USERS, HANDLE_PAYMENTS, OWNER.
- """
- user: User
+ """Unique token associated with a payment."""
+ token: String!
- """The channel for which checkout was created."""
- channel: Channel!
+ """Checkout associated with a payment."""
+ checkout: Checkout
- """The billing address of the checkout."""
- billingAddress: Address
+ """Order associated with a payment."""
+ order: Order
- """The shipping address of the checkout."""
- shippingAddress: Address
+ """Type of method used for payment."""
+ paymentMethodType: String!
"""
- The customer note for the checkout.
+ IP address of the user who created the payment.
- Added in Saleor 3.21.
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- customerNote: String!
+ customerIpAddress: String
- """The note for the checkout."""
- note: String! @deprecated(reason: "Use `customerNote` instead.")
+ """Internal payment status."""
+ chargeStatus: PaymentChargeStatusEnum!
"""
- The total discount applied to the checkout. Note: Only discount created via voucher are included in this field.
+ List of actions that can be performed in the current state of a payment.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- discount: Money
+ actions: [OrderAction!]!
- """The name of voucher assigned to the checkout."""
- discountName: String
+ """Total amount of the payment."""
+ total: Money
- """
- Translation of the discountName field in the language set in Checkout.languageCode field.Note: this field is set automatically when Checkout.languageCode is defined; otherwise it's null
- """
- translatedDiscountName: String
+ """Total amount captured for this payment."""
+ capturedAmount: Money
"""
- The voucher assigned to the checkout.
-
- Added in Saleor 3.18.
+ List of all transactions within this payment.
- Requires one of the following permissions: MANAGE_DISCOUNTS.
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- voucher: Voucher
-
- """The code of voucher assigned to the checkout."""
- voucherCode: String
+ transactions: [Transaction!]
"""
- Shipping methods that can be used with this checkout.
+ Maximum amount of money that can be captured.
- Triggers the following webhook events:
- - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
- - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- availableShippingMethods: [ShippingMethod!]! @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS]) @deprecated(reason: "Use `shippingMethods` instead.")
+ availableCaptureAmount: Money
"""
- Shipping methods that can be used with this checkout.
+ Maximum amount of money that can be refunded.
- Triggers the following webhook events:
- - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
- - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- shippingMethods: [ShippingMethod!]! @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS])
+ availableRefundAmount: Money
- """Collection points that can be used for this order."""
- availableCollectionPoints: [Warehouse!]!
+ """The details of the card used for this payment."""
+ creditCard: CreditCard
- """
- List of available payment gateways.
-
- Triggers the following webhook events:
- - PAYMENT_LIST_GATEWAYS (sync): Fetch payment gateways available for checkout.
- """
- availablePaymentGateways: [PaymentGateway!]! @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_LIST_GATEWAYS])
+ """Informs whether this is a partial payment."""
+ partial: Boolean!
- """Email of a customer."""
- email: String
+ """PSP reference of the payment."""
+ pspReference: String
+}
- """List of gift cards associated with this checkout."""
- giftCards: [GiftCard!]!
+"""An object representing a single payment."""
+type Transaction implements Node {
+ """ID of the transaction."""
+ id: ID!
- """Returns True, if checkout requires shipping."""
- isShippingRequired: Boolean!
+ """Date and time at which transaction was created."""
+ created: DateTime!
- """The number of items purchased."""
- quantity: Int!
+ """Determines the payment associated with a transaction."""
+ payment: Payment!
- """
- Date when oldest stock reservation for this checkout expires or null if no stock is reserved.
- """
- stockReservationExpires: DateTime
+ """Unique token associated with a transaction."""
+ token: String!
- """
- A list of checkout lines, each containing information about an item in the checkout.
- """
- lines: [CheckoutLine!]!
+ """Determines the type of transaction."""
+ kind: TransactionKind!
- """
- The price of the shipping, with all the taxes included. Set to 0 when no delivery method is selected.
-
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
- """
- shippingPrice: TaxedMoney! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
+ """Determines if the transaction was successful."""
+ isSuccess: Boolean!
- """
- The shipping method related with checkout.
-
- Triggers the following webhook events:
- - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
- - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
- """
- shippingMethod: ShippingMethod @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS]) @deprecated(reason: "Use `deliveryMethod` instead.")
+ """Error associated with transaction, if any."""
+ error: String
- """
- The delivery method selected for this checkout.
-
- Triggers the following webhook events:
- - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Optionally triggered when cached external shipping methods are invalid.
- - CHECKOUT_FILTER_SHIPPING_METHODS (sync): Optionally triggered when cached filtered shipping methods are invalid.
- """
- deliveryMethod: DeliveryMethod @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS])
+ """Response returned by payment gateway."""
+ gatewayResponse: JSONString! @deprecated(reason: "This field is a part of a legacy Payments API. Please use apps instead.")
- """
- The price of the checkout before shipping, with taxes included.
-
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
- """
- subtotalPrice: TaxedMoney! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
+ """Total amount of the transaction."""
+ amount: Money
+}
- """Returns True if checkout has to be exempt from taxes."""
- taxExemption: Boolean!
+enum TransactionKind {
+ EXTERNAL
+ AUTH
+ PENDING
+ ACTION_TO_CONFIRM
+ REFUND
+ REFUND_ONGOING
+ CAPTURE
+ VOID
+ CONFIRM
+ CANCEL
+}
- """The checkout's token."""
- token: UUID!
+type CreditCard {
+ """Card brand."""
+ brand: String!
- """
- The sum of the checkout line prices, with all the taxes,shipping costs, and discounts included.
-
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
- """
- totalPrice: TaxedMoney! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
+ """First 4 digits of the card number."""
+ firstDigits: String
- """
- The difference between the paid and the checkout total amount.
-
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
- """
- totalBalance: Money! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
+ """Last 4 digits of the card number."""
+ lastDigits: String!
- """Checkout language code."""
- languageCode: LanguageCodeEnum!
+ """Two-digit number representing the card’s expiration month."""
+ expMonth: Int
- """
- List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS.
- """
- transactions: [TransactionItem!]
+ """Four-digit number representing the card’s expiration year."""
+ expYear: Int
+}
- """Determines whether displayed prices should include taxes."""
- displayGrossPrices: Boolean!
+"""History log of the order."""
+type OrderEvent implements Node {
+ """ID of the event associated with an order."""
+ id: ID!
- """
- The authorize status of the checkout.
-
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
- """
- authorizeStatus: CheckoutAuthorizeStatusEnum! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
+ """Date when event happened at in ISO 8601 format."""
+ date: DateTime
- """
- The charge status of the checkout.
-
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
- """
- chargeStatus: CheckoutChargeStatusEnum! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
+ """Order event type."""
+ type: OrderEventsEnum
+
+ """User who performed the action."""
+ user: User
"""
- List of user's stored payment methods that can be used in this checkout session. It uses the channel that the checkout was created in. When `amount` is not provided, `checkout.total` will be used as a default value.
+ App that performed the action. Requires of of the following permissions: MANAGE_APPS, MANAGE_ORDERS, OWNER.
"""
- storedPaymentMethods(
- """Amount that will be used to fetch stored payment methods."""
- amount: PositiveDecimal
- ): [StoredPaymentMethod!]
+ app: App
- """List of problems with the checkout."""
- problems: [CheckoutProblem!]
-}
+ """Content of the event."""
+ message: String
-"""
-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 of the gift card."""
- id: ID!
+ """Email of the customer."""
+ email: String
- """List of private metadata items. Requires staff permissions to access."""
- privateMetadata: [MetadataItem!]!
+ """Type of an email sent to the customer."""
+ emailType: OrderEventsEmailsEnum
- """
- A single key from private metadata. Requires staff permissions to access.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- privateMetafield(key: String!): String
+ """Amount of money."""
+ amount: Float
- """
- 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
+ """The payment reference from the payment provider."""
+ paymentId: String
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ """The payment gateway of the payment."""
+ paymentGateway: String
- """
- A single key from public metadata.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- metafield(key: String!): String
+ """Number of items."""
+ quantity: Int
- """
- Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
- """
- metafields(keys: [String!]): Metadata
+ """Composed ID of the Fulfillment."""
+ composedId: String
- """Code in format which allows displaying in a user interface."""
- displayCode: String!
+ """User-friendly number of an order."""
+ orderNumber: String
- """Last 4 characters of gift card code."""
- last4CodeChars: String!
+ """Number of an invoice related to the order."""
+ invoiceNumber: String
- """
- Gift card code. It can be fetched both by a staff member with 'MANAGE_GIFT_CARD' when gift card hasn't been used yet or a user who bought or issued the gift card.
-
- Requires one of the following permissions: MANAGE_GIFT_CARD, OWNER.
- """
- code: String!
+ """List of oversold lines names."""
+ oversoldItems: [String!]
- """Date and time when gift card was created."""
- created: DateTime!
+ """The concerned lines."""
+ lines: [OrderEventOrderLineObject!]
- """The user who bought or issued a gift card."""
- createdBy: User
+ """The lines fulfilled."""
+ fulfilledItems: [FulfillmentLine!]
- """The customer who used a gift card."""
- usedBy: User @deprecated
+ """The warehouse were items were restocked."""
+ warehouse: Warehouse
- """
- Email address of the user who bought or issued gift card.
-
- Requires one of the following permissions: MANAGE_USERS, OWNER.
- """
- createdByEmail: String
+ """The transaction reference of captured payment."""
+ transactionReference: String
- """Email address of the customer who used a gift card."""
- usedByEmail: String @deprecated
+ """Define if shipping costs were included to the refund."""
+ shippingCostsIncluded: Boolean
- """Date and time when gift card was last used."""
- lastUsedOn: DateTime
+ """The order which is related to this order."""
+ relatedOrder: Order
- """Expiry date of the gift card."""
- expiryDate: Date
+ """The order event which is related to this event."""
+ related: OrderEvent
- """
- App which created the gift card.
-
- Requires one of the following permissions: MANAGE_APPS, OWNER.
- """
- app: App
+ """The discount applied to the order."""
+ discount: OrderEventDiscountObject
- """Related gift card product."""
- product: Product
+ """The reference of payment's transaction."""
+ reference: String
+}
- """
- List of events associated with the gift card.
-
- Requires one of the following permissions: MANAGE_GIFT_CARD.
- """
- events(
- """Filtering options for gift card events."""
- filter: GiftCardEventFilterInput
- ): [GiftCardEvent!]!
+"""The different order event types. """
+enum OrderEventsEnum {
+ DRAFT_CREATED
+ DRAFT_CREATED_FROM_REPLACE
+ ADDED_PRODUCTS
+ REMOVED_PRODUCTS
+ PLACED
+ PLACED_FROM_DRAFT
+ PLACED_AUTOMATICALLY_FROM_PAID_CHECKOUT
+ 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
+ TRANSACTION_REFUND_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
+ NOTE_UPDATED
+ OTHER
+}
- """
- The gift card tag.
-
- Requires one of the following permissions: MANAGE_GIFT_CARD.
- """
- tags: [GiftCardTag!]!
+enum OrderEventsEmailsEnum {
+ PAYMENT_CONFIRMATION
+ CONFIRMED
+ SHIPPING_CONFIRMATION
+ TRACKING_UPDATED
+ ORDER_CONFIRMATION
+ ORDER_CANCEL
+ ORDER_REFUND
+ FULFILLMENT_CONFIRMATION
+ DIGITAL_LINKS
+}
- """Slug of the channel where the gift card was bought."""
- boughtInChannel: String
- isActive: Boolean!
- initialBalance: Money!
- currentBalance: Money!
+type OrderEventOrderLineObject {
+ """The variant quantity."""
+ quantity: Int
- """The customer who bought a gift card."""
- user: User @deprecated(reason: "Use `createdBy` field instead.")
+ """The order line."""
+ orderLine: OrderLine
- """End date of gift card."""
- endDate: DateTime @deprecated(reason: "Use `expiryDate` field instead.")
+ """The variant name."""
+ itemName: String
- """Start date of gift card."""
- startDate: DateTime @deprecated
+ """The discount applied to the order line."""
+ discount: OrderEventDiscountObject
}
-"""History log of the gift card."""
-type GiftCardEvent implements Node @doc(category: "Gift cards") {
- """ID of the event associated with a gift card."""
+type OrderEventDiscountObject {
+ """Type of the discount: fixed or percent."""
+ valueType: DiscountValueTypeEnum!
+
+ """Value of the discount. Can store fixed value or percent value."""
+ value: PositiveDecimal!
+
+ """Explanation for the applied discount."""
+ reason: String
+
+ """Returns amount of discount."""
+ amount: Money
+
+ """Type of the discount: fixed or percent."""
+ oldValueType: DiscountValueTypeEnum
+
+ """Value of the discount. Can store fixed value or percent value."""
+ oldValue: PositiveDecimal
+
+ """Returns amount of discount."""
+ oldAmount: Money
+}
+
+"""Contains all details related to the applied discount to the order."""
+type OrderDiscount implements Node {
+ """The ID of discount applied."""
id: ID!
- """Date when event happened at in ISO 8601 format."""
- date: DateTime
+ """The type of applied discount: Sale, Voucher or Manual."""
+ type: OrderDiscountType!
- """Gift card event type."""
- type: GiftCardEventsEnum
+ """The name of applied discount."""
+ name: String
+
+ """Translated name of the applied discount."""
+ translatedName: String
+
+ """Type of the discount: fixed or percent"""
+ valueType: DiscountValueTypeEnum!
+
+ """Value of the discount. Can store fixed value or percent value"""
+ value: PositiveDecimal!
"""
- User who performed the action. Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER.
+ Explanation for the applied discount.
+
+ Requires one of the following permissions: MANAGE_ORDERS.
"""
- user: User
+ reason: String
+
+ """Returns amount of discount."""
+ amount: Money! @deprecated(reason: "Use `total` instead.")
+
+ """
+ The amount of discount applied to the order.
+
+ Added in Saleor 3.21.
+ """
+ total: Money!
+}
+type OrderError {
"""
- App that performed the action. Requires one of the following permissions: MANAGE_APPS, OWNER.
+ Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
- app: App
+ field: String
- """Content of the event."""
+ """The error message."""
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 error code."""
+ code: OrderErrorCode!
- """The gift card balance."""
- balance: GiftCardEventBalance
+ """Warehouse ID which causes the error."""
+ warehouse: ID
- """The gift card expiry date."""
- expiryDate: Date
+ """List of order line IDs that cause the error."""
+ orderLines: [ID!]
- """Previous gift card expiry date."""
- oldExpiryDate: Date
-}
+ """List of product variants that are associated with the error"""
+ variants: [ID!]
-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
+ """A type of address that causes the error."""
+ addressType: AddressTypeEnum
}
-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
+enum OrderErrorCode {
+ BILLING_ADDRESS_NOT_SET
+ CANNOT_CANCEL_FULFILLMENT
+ CANNOT_CANCEL_ORDER
+ CANNOT_DELETE
+ CANNOT_DISCOUNT
+ CANNOT_REFUND
+ CANNOT_FULFILL_UNPAID_ORDER
+ CAPTURE_INACTIVE_PAYMENT
+ GIFT_CARD_LINE
+ NOT_EDITABLE
+ FULFILL_ORDER_LINE
+ GRAPHQL_ERROR
+ INVALID
+ PRODUCT_NOT_PUBLISHED
+ PRODUCT_UNAVAILABLE_FOR_PURCHASE
+ NOT_FOUND
+ ORDER_NO_SHIPPING_ADDRESS
+ PAYMENT_ERROR
+ PAYMENT_MISSING
+ 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
+ INVALID_VOUCHER
+ INVALID_VOUCHER_CODE
+ NON_EDITABLE_GIFT_LINE
+ NON_REMOVABLE_GIFT_LINE
+ MISSING_ADDRESS_DATA
}
-input GiftCardEventFilterInput @doc(category: "Gift cards") {
- type: GiftCardEventsEnum
- orders: [ID!]
+enum AddressTypeEnum {
+ BILLING
+ SHIPPING
}
-"""The gift card tag."""
-type GiftCardTag implements Node @doc(category: "Gift cards") {
- """ID of the tag associated with a gift card."""
+"""The details of granted refund."""
+type OrderGrantedRefund {
id: ID!
- """Name of the tag associated with a gift card."""
- name: String!
-}
+ """Time of creation."""
+ createdAt: DateTime!
-"""Represents an item in the checkout."""
-type CheckoutLine implements Node & ObjectWithMetadata @doc(category: "Checkout") {
- """The ID of the checkout line."""
- id: ID!
+ """Time of last update."""
+ updatedAt: DateTime!
- """List of private metadata items. Requires staff permissions to access."""
- privateMetadata: [MetadataItem!]!
+ """Refund amount."""
+ amount: Money!
"""
- A single key from private metadata. Requires staff permissions to access.
+ Reason of the refund.
- Tip: Use GraphQL aliases to fetch multiple keys.
+ Added in Saleor 3.22.
"""
- privateMetafield(key: String!): String
+ reason: String
"""
- Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
+ Reason Model (Page) reference for refund.
+
+ Added in Saleor 3.22.
"""
- privateMetafields(keys: [String!]): Metadata
-
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ reasonReference: Page
"""
- A single key from public metadata.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
+ User who performed the action. Requires of of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER.
"""
- metafield(key: String!): String
+ user: User
+
+ """App that performed the action."""
+ app: App
"""
- Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
+ If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price.
"""
- metafields(keys: [String!]): Metadata
-
- """The product variant from which the checkout line was created."""
- variant: ProductVariant!
+ shippingCostsIncluded: Boolean!
- """The quantity of product variant assigned to the checkout line."""
- quantity: Int!
+ """Lines assigned to the granted refund."""
+ lines: [OrderGrantedRefundLine!]
"""
- The unit price of the checkout line, with taxes and discounts.
+ Status of the granted refund calculated based on transactionItem assigned to granted refund.
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ Added in Saleor 3.20.
"""
- unitPrice: TaxedMoney! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
-
- """The unit price of the checkout line, without discounts."""
- undiscountedUnitPrice: Money!
+ status: OrderGrantedRefundStatusEnum!
"""
- The unit price of the checkout line prior to promotion.
+ List of refund events associated with the granted refund.
- Added in Saleor 3.21.
+ Added in Saleor 3.20.
"""
- priorUnitPrice: Money
+ transactionEvents: [TransactionEvent!]
"""
- The sum of the checkout line price, taxes and discounts.
+ The transaction assigned to the granted refund.
- Triggers the following webhook events:
- - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired.
+ Added in Saleor 3.20.
"""
- totalPrice: TaxedMoney! @webhookEventsInfo(asyncEvents: [], syncEvents: [CHECKOUT_CALCULATE_TAXES])
+ transaction: TransactionItem
+}
- """The sum of the checkout line price, without discounts."""
- undiscountedTotalPrice: Money!
+"""Represents granted refund line."""
+type OrderGrantedRefundLine {
+ id: ID!
+
+ """Number of items to refund."""
+ quantity: Int!
+
+ """Line of the order associated with this granted refund."""
+ orderLine: OrderLine!
+
+ """Reason for refunding the line."""
+ reason: String
"""
- The sum of the checkout line price prior to promotion.
+ Reason Model (Page) reference for this refund line.
- Added in Saleor 3.21.
+ Added in Saleor 3.22.
"""
- priorTotalPrice: Money
+ reasonReference: Page
+}
- """Indicates whether the item need to be delivered."""
- requiresShipping: Boolean!
+"Represents the status of a granted refund.\n\n NONE - the refund on related transactionItem is not processed\n PENDING - the refund on related transactionItem is pending\n FULL - the refund on related transactionItem is fully processed\n FAIL - the refund on related transactionItem failed\n "
+enum OrderGrantedRefundStatusEnum {
+ NONE
+ PENDING
+ SUCCESS
+ FAILURE
+}
- """List of problems with the checkout line."""
- problems: [CheckoutLineProblem!]
+"""Represents transaction's event."""
+type TransactionEvent implements Node {
+ """The ID of the object."""
+ id: ID!
+
+ """Date and time at which a transaction event was created."""
+ createdAt: DateTime!
+
+ """PSP reference of transaction."""
+ pspReference: String!
+
+ """Message related to the transaction's event."""
+ message: String!
"""
- Determine if the line is a gift.
-
- Added in Saleor 3.19.
+ Reason model of the transaction refund.
- Note: this API is currently in Feature Preview and can be subject to changes at later point.
+ Added in Saleor 3.22.
"""
- isGift: Boolean
-}
+ reasonReference: Page
-"""Represents an problem in the checkout line."""
-union CheckoutLineProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable
+ """
+ The url that will allow to redirect user to payment provider page with transaction details.
+ """
+ externalUrl: String!
-"""
-Indicates insufficient stock for a given checkout line.Placing the order will not be possible until solving this problem.
-"""
-type CheckoutLineProblemInsufficientStock @doc(category: "Checkout") {
- """Available quantity of a variant."""
- availableQuantity: Int
+ """The amount related to this event."""
+ amount: Money!
- """The line that has variant with insufficient stock."""
- line: CheckoutLine!
+ """The type of action related to this event."""
+ type: TransactionEventTypeEnum
- """The variant with insufficient stock."""
- variant: ProductVariant!
+ """User or App that created the transaction event."""
+ createdBy: UserOrApp
+
+ """Idempotency key assigned to the event."""
+ idempotencyKey: String
+}
+
+"Represents possible event types.\n\n Added in Saleor 3.12.\n\n The following types are possible:\n AUTHORIZATION_SUCCESS - represents success authorization.\n AUTHORIZATION_FAILURE - represents failure authorization.\n AUTHORIZATION_ADJUSTMENT - represents authorization adjustment.\n AUTHORIZATION_REQUEST - represents authorization request.\n AUTHORIZATION_ACTION_REQUIRED - represents authorization that needs\n additional actions from the customer.\n CHARGE_ACTION_REQUIRED - represents charge that needs\n additional actions from the customer.\n CHARGE_SUCCESS - represents success charge.\n CHARGE_FAILURE - represents failure charge.\n CHARGE_BACK - represents chargeback.\n CHARGE_REQUEST - represents charge request.\n REFUND_SUCCESS - represents success refund.\n REFUND_FAILURE - represents failure refund.\n REFUND_REVERSE - represents reverse refund.\n REFUND_REQUEST - represents refund request.\n CANCEL_SUCCESS - represents success cancel.\n CANCEL_FAILURE - represents failure cancel.\n CANCEL_REQUEST - represents cancel request.\n INFO - represents info event.\n "
+enum TransactionEventTypeEnum {
+ 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
+
"""
-The variant assigned to the checkout line is not available.Placing the order will not be possible until solving this problem.
+Represents a payment method used for a transaction.
+
+Added in Saleor 3.22.
"""
-type CheckoutLineProblemVariantNotAvailable @doc(category: "Checkout") {
- """The line that has variant that is not available."""
- line: CheckoutLine!
+interface PaymentMethodDetails {
+ """Name of the payment method."""
+ name: String!
+}
+
+"Determine a current authorize status for checkout.\n\n We treat the checkout as fully authorized when the sum of authorized and charged\n funds cover the checkout.total.\n We treat the checkout as partially authorized when the sum of authorized and charged\n funds covers only part of the checkout.total\n We treat the checkout as not authorized when the sum of authorized and charged funds\n is 0.\n\n NONE - the funds are not authorized\n PARTIAL - the cover funds don't cover fully the checkout's total\n FULL - the cover funds covers the checkout's total\n "
+enum CheckoutAuthorizeStatusEnum {
+ NONE
+ PARTIAL
+ FULL
+}
+
+"Determine the current charge status for the checkout.\n\n The checkout is considered overcharged when the sum of the transactionItem's charge\n amounts exceeds the value of `checkout.total`.\n If the sum of the transactionItem's charge amounts equals\n `checkout.total`, we consider the checkout to be fully charged.\n If the sum of the transactionItem's charge amounts covers a part of the\n `checkout.total`, we treat the checkout as partially charged.\n\n\n NONE - the funds are not charged.\n PARTIAL - the funds that are charged don't cover the checkout's total\n FULL - the funds that are charged fully cover the checkout's total\n OVERCHARGED - the charged funds are bigger than checkout's total\n "
+enum CheckoutChargeStatusEnum {
+ NONE
+ PARTIAL
+ FULL
+ OVERCHARGED
}
"""
-Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise.
+Represents a payment method stored for user (tokenized) in payment gateway.
"""
-union DeliveryMethod = Warehouse | ShippingMethod
-
-"""Represents a payment transaction."""
-type TransactionItem implements Node & ObjectWithMetadata @doc(category: "Payments") {
- """The ID of the object."""
+type StoredPaymentMethod {
+ """Stored payment 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.
- """
- privateMetafield(key: String!): String
+ """Payment gateway that stores this payment method."""
+ gateway: PaymentGateway!
"""
- Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
+ ID of stored payment method used to make payment actions. Note: method ID is unique only within the payment gateway.
"""
- privateMetafields(keys: [String!]): Metadata
+ paymentMethodId: String!
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ """Stored credit card details if available."""
+ creditCardInfo: CreditCard
+ supportedPaymentFlows: [TokenizedPaymentFlowEnum!]
- """
- A single key from public metadata.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- metafield(key: String!): String
+ """Type of the payment method. Example: credit card, wallet, etc."""
+ type: String!
"""
- Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
+ Payment method name. Example: last 4 digits of credit card, obfuscated email, etc.
"""
- metafields(keys: [String!]): Metadata
+ name: String
- """The transaction token."""
- token: UUID!
+ """JSON data returned by Payment Provider app for this payment method."""
+ data: JSON
+}
- """Date and time at which payment transaction was created."""
- createdAt: DateTime!
+"Represents possible tokenized payment flows that can be used to process payment.\n\n The following flows are possible:\n INTERACTIVE - Payment method can be used for 1 click checkout - it's prefilled in\n checkout form (might require additional authentication from user)\n "
+enum TokenizedPaymentFlowEnum {
+ INTERACTIVE
+}
- """Date and time at which payment transaction was modified."""
- modifiedAt: DateTime!
+"""Represents an problem in the checkout."""
+union CheckoutProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable
- """
- List of actions that can be performed in the current state of a payment.
- """
- actions: [TransactionActionEnum!]!
+type CheckoutCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [CheckoutCountableEdge!]!
- """Total amount authorized for this payment."""
- authorizedAmount: Money!
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Total amount of ongoing authorization requests for the transaction."""
- authorizePendingAmount: Money!
+type CheckoutCountableEdge {
+ """The item at the end of the edge."""
+ node: Checkout!
- """Total amount refunded for this payment."""
- refundedAmount: Money!
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """Total amount of ongoing refund requests for the transaction."""
- refundPendingAmount: Money!
+type GiftCardCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [GiftCardCountableEdge!]!
- """Total amount canceled for this payment."""
- canceledAmount: Money!
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Total amount of ongoing cancel requests for the transaction."""
- cancelPendingAmount: Money!
+type GiftCardCountableEdge {
+ """The item at the end of the edge."""
+ node: GiftCard!
- """Total amount charged for this payment."""
- chargedAmount: Money!
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """Total amount of ongoing charge requests for the transaction."""
- chargePendingAmount: Money!
+type OrderCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [OrderCountableEdge!]!
- """Name of the transaction."""
- name: String!
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Message related to the transaction."""
- message: String!
+type OrderCountableEdge {
+ """The item at the end of the edge."""
+ node: Order!
- """PSP reference of transaction."""
- pspReference: String!
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """The related order."""
- order: Order
+"""Represents user's permissions."""
+type UserPermission {
+ """Internal code for permission."""
+ code: PermissionEnum!
- """The related checkout."""
- checkout: Checkout
+ """Describe action(s) allowed to do by permission."""
+ name: String!
- """List of all transaction's events."""
- events: [TransactionEvent!]!
+ """List of user permission groups which contains this permission."""
+ sourcePermissionGroups(
+ """ID of user whose groups should be returned."""
+ userId: ID!
+ ): [Group!]
+}
- """User or App that created the transaction."""
- createdBy: UserOrApp
+"""Represents permission group data."""
+type Group implements Node {
+ """The ID of the group."""
+ id: ID!
- """
- The url that will allow to redirect user to payment provider page with transaction details.
- """
- externalUrl: String!
+ """The name of the group."""
+ name: String!
"""
- The payment method used for this transaction.
+ List of group users
- Added in Saleor 3.22.
+ Requires one of the following permissions: MANAGE_STAFF.
"""
- paymentMethodDetails: PaymentMethodDetails
+ users: [User!]
- """
- Reason of the refund.
-
- Added in Saleor 3.22.
- """
- reason: String
+ """List of group permissions"""
+ permissions: [Permission!]
"""
- Reason `Page` (Model) for refund.
-
- Added in Saleor 3.22.
+ True, if the currently authenticated user has rights to manage a group.
"""
- reasonReference: Page
-}
+ userCanManage: Boolean!
-"""
-Represents possible actions on payment transaction.
+ """List of channels the group has access to."""
+ accessibleChannels: [Channel!]
- The following actions are possible:
- CHARGE - Represents the charge action.
- REFUND - Represents a refund action.
- CANCEL - Represents a cancel action. Added in Saleor 3.12.
-"""
-enum TransactionActionEnum @doc(category: "Payments") {
- CHARGE
- REFUND
- CANCEL
+ """Determine if the group have restricted access to channels."""
+ restrictedAccessToChannels: Boolean!
}
-"""Represents an order in the shop."""
-type Order implements Node & ObjectWithMetadata @doc(category: "Orders") {
- """ID of the order."""
+"""History log of the customer."""
+type CustomerEvent implements Node {
+ """The ID of the customer event."""
id: ID!
- """List of private metadata items. Requires staff permissions to access."""
- privateMetadata: [MetadataItem!]!
+ """Date when event happened at in ISO 8601 format."""
+ date: DateTime
- """
- A single key from private metadata. Requires staff permissions to access.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- privateMetafield(key: String!): String
+ """Customer event type."""
+ type: CustomerEventsEnum
- """
- 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
+ """User who performed the action."""
+ user: User
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ """App that performed the action."""
+ app: App
- """
- A single key from public metadata.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- metafield(key: String!): String
+ """Content of the event."""
+ message: String
- """
- Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
- """
- metafields(keys: [String!]): Metadata
+ """Number of objects concerned by the event."""
+ count: Int
- """Date and time when the order was created."""
- created: DateTime!
+ """The concerned order."""
+ order: Order
- """Date and time when the order was created."""
- updatedAt: DateTime!
+ """The concerned order line."""
+ orderLine: OrderLine
+}
- """Status of the order."""
- status: OrderStatus!
+enum CustomerEventsEnum {
+ ACCOUNT_CREATED
+ ACCOUNT_ACTIVATED
+ ACCOUNT_DEACTIVATED
+ PASSWORD_RESET_LINK_SENT
+ PASSWORD_RESET
+ EMAIL_CHANGED_REQUEST
+ PASSWORD_CHANGED
+ EMAIL_CHANGED
+ PLACED_ORDER
+ NOTE_ADDED_TO_ORDER
+ DIGITAL_LINK_DOWNLOADED
+ CUSTOMER_DELETED
+ NAME_ASSIGNED
+ EMAIL_ASSIGNED
+ NOTE_ADDED
+}
- """
- 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, HANDLE_PAYMENTS, OWNER.
- """
- user: User
+"""
+Represents a payment source stored for user in payment gateway, such as credit card.
+"""
+type PaymentSource {
+ """Payment gateway name."""
+ gateway: String!
- """Google Analytics tracking client ID."""
- trackingClientId: String!
+ """ID of stored payment method."""
+ paymentMethodId: 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
+ """Stored credit card details if available."""
+ creditCardInfo: CreditCard
"""
- 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.
+ List of public metadata items.
+
+ Can be accessed without permissions.
"""
- shippingAddress: Address
+ metadata: [MetadataItem!]!
+}
- """Method used for shipping."""
- shippingMethodName: String
+"""Represents the app's brand data."""
+type AppBrand {
+ """App's logos details."""
+ logo: AppBrandLogo!
+}
- """
- Name of the collection point where the order should be picked up by the customer.
- """
- collectionPointName: String
+"""Represents the app's brand logo data."""
+type AppBrandLogo {
+ """URL to the default logo image."""
+ 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
- """Channel through which the order was placed."""
- channel: Channel!
+ """
+ The format of the image. When not provided, format of the original image will be used.
+ """
+ format: IconThumbnailFormatEnum
+ ): String!
+}
- """List of shipments for the order."""
- fulfillments: [Fulfillment!]!
+"""Thumbnail formats for icon images."""
+enum IconThumbnailFormatEnum {
+ ORIGINAL
+ WEBP
+}
- """List of order lines."""
- lines: [OrderLine!]!
+"""Enum determining the state of a circuit breaker."""
+enum CircuitBreakerStateEnum {
+ """The breaker is conducting (requests are passing through)."""
+ CLOSED
"""
- List of actions that can be performed in the current state of an order.
+ The breaker is in a trial period (to close or open). Note that unlike classic breaker patterns, this is not a state where we are throttling the number of requests, it's a state similar to CLOSED but with different thresholds.
"""
- 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."""
- availableCollectionPoints: [Warehouse!]!
+ HALF_OPEN
"""
- 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.
+ The breaker is tripped (no requests are passing). Breaker will enter half-open state after cooldown period.
"""
- invoices: [Invoice!]!
-
- """User-friendly number of an order."""
- number: String!
-
- """The ID of the order that was the base for this order."""
- original: ID
+ OPEN
+}
- """The order origin."""
- origin: OrderOriginEnum!
+type EventDeliveryCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [EventDeliveryCountableEdge!]!
- """Informs if an order is fully paid."""
- isPaid: Boolean!
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Internal payment status."""
- paymentStatus: PaymentChargeStatusEnum!
+type EventDeliveryCountableEdge {
+ """The item at the end of the edge."""
+ node: EventDelivery!
- """User-friendly payment status."""
- paymentStatusDisplay: String!
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """The authorize status of the order."""
- authorizeStatus: OrderAuthorizeStatusEnum!
+"""Event delivery."""
+type EventDelivery implements Node {
+ """The ID of an event delivery."""
+ id: ID!
- """The charge status of the order."""
- chargeStatus: OrderChargeStatusEnum!
+ """Creation time of an event delivery."""
+ createdAt: DateTime!
- """Returns True if order has to be exempt from taxes."""
- taxExemption: Boolean!
+ """Event delivery status."""
+ status: EventDeliveryStatusEnum!
- """
- List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS.
- """
- transactions: [TransactionItem!]!
+ """Webhook event type."""
+ eventType: WebhookEventTypeEnum!
- """List of payments for the order."""
- payments: [Payment!]!
+ """Event delivery attempts."""
+ attempts(
+ """Event delivery sorter"""
+ sortBy: EventDeliveryAttemptSortingInput
- """Total amount of the order."""
- total: TaxedMoney!
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """Undiscounted total amount of the order."""
- undiscountedTotal: TaxedMoney!
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """Shipping method for this order."""
- shippingMethod: ShippingMethod @deprecated(reason: "Use `deliveryMethod` instead.")
+ """
+ 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
- """
- Undiscounted total price of shipping.
-
- Added in Saleor 3.19.
- """
- undiscountedShippingPrice: Money!
+ """
+ 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
- """Total price of shipping."""
- shippingPrice: TaxedMoney!
+ """Event payload."""
+ payload: String
+}
- """The shipping tax rate value."""
- shippingTaxRate: Float!
+enum EventDeliveryStatusEnum {
+ PENDING
+ SUCCESS
+ FAILED
+}
- """
- Denormalized tax class assigned to the shipping method.
-
- Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
- """
- shippingTaxClass: TaxClass
+type EventDeliveryAttemptCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [EventDeliveryAttemptCountableEdge!]!
- """Denormalized name of the tax class assigned to the shipping method."""
- shippingTaxClassName: String
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Denormalized public metadata of the shipping method's tax class."""
- shippingTaxClassMetadata: [MetadataItem!]!
+type EventDeliveryAttemptCountableEdge {
+ """The item at the end of the edge."""
+ node: EventDeliveryAttempt!
- """
- Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access.
- """
- shippingTaxClassPrivateMetadata: [MetadataItem!]!
- token: String! @deprecated(reason: "Use `id` instead.")
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """Voucher linked to the order."""
- voucher: Voucher
+"""Event delivery attempts."""
+type EventDeliveryAttempt implements Node {
+ """The ID of Event Delivery Attempt."""
+ id: ID!
- """
- Voucher code that was used for Order.
-
- Added in Saleor 3.18.
- """
- voucherCode: String
+ """Event delivery creation date and time."""
+ createdAt: DateTime!
- """List of user gift cards."""
- giftCards: [GiftCard!]!
+ """Task id for delivery attempt."""
+ taskId: String
- """Additional information provided by the customer about the order."""
- customerNote: String!
+ """Delivery attempt duration."""
+ duration: Float
- """Weight of the order."""
- weight: Weight!
+ """Delivery attempt response content."""
+ response: String
- """URL to which user should be redirected after order is placed."""
- redirectUrl: String
+ """Response headers for delivery attempt."""
+ responseHeaders: String
- """The sum of line prices not including shipping."""
- subtotal: TaxedMoney!
+ """Delivery attempt response status code."""
+ responseStatusCode: Int
- """User-friendly order status."""
- statusDisplay: String!
+ """Request headers for delivery attempt."""
+ requestHeaders: String
- """
- Informs whether a draft order can be finalized(turned into a regular order).
- """
- canFinalize: Boolean!
+ """Event delivery status."""
+ status: EventDeliveryStatusEnum!
+}
- """Amount authorized for the order."""
- totalAuthorized: Money!
+input EventDeliveryAttemptSortingInput {
+ """Specifies the direction in which to sort attempts."""
+ direction: OrderDirection!
- """Amount captured for the order."""
- totalCaptured: Money! @deprecated(reason: "Use `totalCharged` instead.")
+ """Sort attempts by the selected field."""
+ field: EventDeliveryAttemptSortField!
+}
- """Amount charged for the order."""
- totalCharged: Money!
+enum EventDeliveryAttemptSortField {
+ """Sort event delivery attempts by created at."""
+ CREATED_AT
+}
- """Amount canceled for the order."""
- totalCanceled: Money!
+input EventDeliverySortingInput {
+ """Specifies the direction in which to sort deliveries."""
+ direction: OrderDirection!
- """
- List of events associated with the order.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- events: [OrderEvent!]!
+ """Sort deliveries by the selected field."""
+ field: EventDeliverySortField!
+}
- """The difference between the paid and the order total amount."""
- totalBalance: Money!
+enum EventDeliverySortField {
+ """Sort event deliveries by created at."""
+ CREATED_AT
+}
- """
- 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
+input EventDeliveryFilterInput {
+ status: EventDeliveryStatusEnum
+ eventType: WebhookEventTypeEnum
+}
- """Returns True, if order requires shipping."""
- isShippingRequired: Boolean!
+enum WebhookSampleEventTypeEnum {
+ ACCOUNT_CONFIRMATION_REQUESTED
+ ACCOUNT_CHANGE_EMAIL_REQUESTED
+ ACCOUNT_EMAIL_CHANGED
+ ACCOUNT_SET_PASSWORD_REQUESTED
+ ACCOUNT_CONFIRMED
+ ACCOUNT_DELETE_REQUESTED
+ ACCOUNT_DELETED
+ 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
+ CHANNEL_METADATA_UPDATED
+ GIFT_CARD_CREATED
+ GIFT_CARD_UPDATED
+ GIFT_CARD_DELETED
+ GIFT_CARD_SENT
+ GIFT_CARD_STATUS_CHANGED
+ GIFT_CARD_METADATA_UPDATED
+ GIFT_CARD_EXPORT_COMPLETED
+ 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
+ FULFILLMENT_CREATED
+ FULFILLMENT_CANCELED
+ FULFILLMENT_APPROVED
+ FULFILLMENT_METADATA_UPDATED
+ FULFILLMENT_TRACKING_NUMBER_UPDATED
+ DRAFT_ORDER_CREATED
+ DRAFT_ORDER_UPDATED
+ DRAFT_ORDER_DELETED
+ SALE_CREATED
+ SALE_UPDATED
+ SALE_DELETED
+ SALE_TOGGLE
+ PROMOTION_CREATED
+ PROMOTION_UPDATED
+ PROMOTION_DELETED
+ PROMOTION_STARTED
+ PROMOTION_ENDED
+ PROMOTION_RULE_CREATED
+ PROMOTION_RULE_UPDATED
+ PROMOTION_RULE_DELETED
+ INVOICE_REQUESTED
+ INVOICE_DELETED
+ INVOICE_SENT
+ CUSTOMER_CREATED
+ CUSTOMER_UPDATED
+ CUSTOMER_DELETED
+ CUSTOMER_METADATA_UPDATED
+ COLLECTION_CREATED
+ COLLECTION_UPDATED
+ COLLECTION_DELETED
+ COLLECTION_METADATA_UPDATED
+ PRODUCT_CREATED
+ PRODUCT_UPDATED
+ PRODUCT_DELETED
+ PRODUCT_METADATA_UPDATED
+ PRODUCT_EXPORT_COMPLETED
+ PRODUCT_MEDIA_CREATED
+ PRODUCT_MEDIA_UPDATED
+ PRODUCT_MEDIA_DELETED
+ PRODUCT_VARIANT_CREATED
+ PRODUCT_VARIANT_UPDATED
+ PRODUCT_VARIANT_DELETED
+ PRODUCT_VARIANT_METADATA_UPDATED
+ PRODUCT_VARIANT_OUT_OF_STOCK
+ PRODUCT_VARIANT_BACK_IN_STOCK
+ PRODUCT_VARIANT_STOCK_UPDATED
+ CHECKOUT_CREATED
+ CHECKOUT_UPDATED
+ CHECKOUT_FULLY_AUTHORIZED
+ CHECKOUT_FULLY_PAID
+ CHECKOUT_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
+ STAFF_SET_PASSWORD_REQUESTED
+ TRANSACTION_ITEM_METADATA_UPDATED
+ TRANSLATION_CREATED
+ TRANSLATION_UPDATED
+ WAREHOUSE_CREATED
+ WAREHOUSE_UPDATED
+ WAREHOUSE_DELETED
+ WAREHOUSE_METADATA_UPDATED
+ VOUCHER_CREATED
+ VOUCHER_UPDATED
+ VOUCHER_DELETED
+ VOUCHER_CODES_CREATED
+ VOUCHER_CODES_DELETED
+ VOUCHER_METADATA_UPDATED
+ VOUCHER_CODE_EXPORT_COMPLETED
+ OBSERVABILITY
+ THUMBNAIL_CREATED
+ SHOP_METADATA_UPDATED
+}
- """The delivery method selected for this order."""
- deliveryMethod: DeliveryMethod
- languageCode: String! @deprecated(reason: "Use the `languageCodeEnum` field to fetch the language code.")
+type WarehouseCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [WarehouseCountableEdge!]!
- """Order language code."""
- languageCodeEnum: LanguageCodeEnum!
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Returns applied discount."""
- discount: Money @deprecated(reason: "Use the `discounts` field instead.")
+type WarehouseCountableEdge {
+ """The item at the end of the edge."""
+ node: Warehouse!
- """Discount name."""
- discountName: String @deprecated(reason: "Use the `discounts` field instead.")
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """Translated discount name."""
- translatedDiscountName: String @deprecated(reason: "Use the `discounts` field instead.")
+input WarehouseFilterInput {
+ clickAndCollectOption: WarehouseClickAndCollectOptionEnum
+ metadata: [MetadataFilter!]
+ search: String
+ ids: [ID!]
+ isPrivate: Boolean
+ channels: [ID!]
+ slugs: [String!]
+}
- """List of all discounts assigned to the order."""
- discounts: [OrderDiscount!]!
+input WarehouseSortingInput {
+ """Specifies the direction in which to sort warehouses."""
+ direction: OrderDirection!
- """List of errors that occurred during order validation."""
- errors: [OrderError!]!
+ """Sort warehouses by the selected field."""
+ field: WarehouseSortField!
+}
- """Determines whether displayed prices should include taxes."""
- displayGrossPrices: Boolean!
+enum WarehouseSortField {
+ """Sort warehouses by name."""
+ NAME
+}
- """External ID of this order."""
- externalReference: String
+type TranslatableItemConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [TranslatableItemEdge!]!
- """ID of the checkout that the order was created from."""
- checkoutId: ID
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """
- List of granted refunds.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- grantedRefunds: [OrderGrantedRefund!]!
+type TranslatableItemEdge {
+ """The item at the end of the edge."""
+ node: TranslatableItem!
- """
- Total amount of granted refund.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- totalGrantedRefund: Money!
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """Total refund amount for the order."""
- totalRefunded: Money!
+union TranslatableItem = ProductTranslatableContent | CollectionTranslatableContent | CategoryTranslatableContent | AttributeTranslatableContent | AttributeValueTranslatableContent | ProductVariantTranslatableContent | PageTranslatableContent | ShippingMethodTranslatableContent | VoucherTranslatableContent | MenuItemTranslatableContent | PromotionTranslatableContent | PromotionRuleTranslatableContent | SaleTranslatableContent
- """
- Total amount of ongoing refund requests for the order's transactions.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- totalRefundPending: Money!
+"""
+Represents menu item's original translatable fields and related translations.
+"""
+type MenuItemTranslatableContent implements Node {
+ """The ID of the menu item translatable content."""
+ id: ID!
- """
- Total amount of ongoing authorize requests for the order's transactions.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- totalAuthorizePending: Money!
+ """The ID of the menu item to translate."""
+ menuItemId: ID!
- """
- Total amount of ongoing charge requests for the order's transactions.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- totalChargePending: Money!
+ """Name of the menu item to translate."""
+ name: String!
- """
- Total amount of ongoing cancel requests for the order's transactions.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- totalCancelPending: Money!
+ """Returns translated menu item fields for the given language code."""
+ translation(
+ """A language code to return the translation for menu item."""
+ languageCode: LanguageCodeEnum!
+ ): MenuItemTranslation
"""
- The difference amount between granted refund and the amounts that are pending and refunded.
-
- Requires one of the following permissions: MANAGE_ORDERS.
+ Represents a single item of the related menu. Can store categories, collection or pages.
"""
- totalRemainingGrant: Money!
+ menuItem: MenuItem @deprecated(reason: "Get model fields from the root level queries.")
}
-enum OrderStatus @doc(category: "Orders") {
- DRAFT
- UNCONFIRMED
- UNFULFILLED
- PARTIALLY_FULFILLED
- PARTIALLY_RETURNED
- RETURNED
- FULFILLED
- CANCELED
- EXPIRED
+"""Represents menu item translations."""
+type MenuItemTranslation implements Node {
+ """The ID of the menu item translation."""
+ id: ID!
+
+ """Translation language."""
+ language: LanguageDisplay!
+
+ """Translated menu item name."""
+ name: String!
+
+ """Represents the menu item fields to translate."""
+ translatableContent: MenuItemTranslatableContent
}
-"""Represents order fulfillment."""
-type Fulfillment implements Node & ObjectWithMetadata @doc(category: "Orders") {
- """ID of the fulfillment."""
+"""
+Represents a single item of the related menu. Can store categories, collection or pages.
+"""
+type MenuItem implements Node & ObjectWithMetadata {
+ """The ID of the menu item."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -11549,59 +13807,49 @@ type Fulfillment implements Node & ObjectWithMetadata @doc(category: "Orders") {
"""
metafields(keys: [String!]): Metadata
- """Sequence in which the fulfillments were created for an order."""
- fulfillmentOrder: Int!
-
- """Status of fulfillment."""
- status: FulfillmentStatus!
-
- """Fulfillment tracking number."""
- trackingNumber: String!
-
- """Date and time when fulfillment was created."""
- created: DateTime!
+ """The name of the menu item."""
+ name: String!
- """List of lines for the fulfillment."""
- lines: [FulfillmentLine!]
+ """Represents the menu to which the menu item belongs."""
+ menu: Menu!
- """User-friendly fulfillment status."""
- statusDisplay: String
+ """ID of parent menu item. If empty, menu will be top level menu."""
+ parent: MenuItem
- """Warehouse from fulfillment was fulfilled."""
- warehouse: Warehouse
+ """Category associated with the menu item."""
+ category: Category
- """Amount of refunded shipping price."""
- shippingRefundedAmount: Money
+ """
+ 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
- """Total refunded amount assigned to this fulfillment."""
- totalRefundedAmount: Money
-}
+ """
+ A page associated with this menu item. Requires one of the following permissions to include unpublished items: MANAGE_PAGES.
+ """
+ page: Page
-enum FulfillmentStatus @doc(category: "Orders") {
- FULFILLED
- REFUNDED
- RETURNED
- REPLACED
- REFUNDED_AND_RETURNED
- CANCELED
- WAITING_FOR_APPROVAL
-}
+ """Indicates the position of the menu item within the menu structure."""
+ level: Int!
-"""Represents line of the fulfillment."""
-type FulfillmentLine implements Node @doc(category: "Orders") {
- """ID of the fulfillment line."""
- id: ID!
+ """Represents the child items of the current menu item."""
+ children: [MenuItem!]
- """The number of items included in the fulfillment line."""
- quantity: Int!
+ """URL to the menu item."""
+ url: String
- """The order line to which the fulfillment line is related."""
- orderLine: OrderLine
+ """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 order line of particular order."""
-type OrderLine implements Node & ObjectWithMetadata @doc(category: "Orders") {
- """ID of the order line."""
+"""
+Represents a single menu - an object that is used to help navigate through the store.
+"""
+type Menu implements Node & ObjectWithMetadata {
+ """The ID of the menu."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -11634,379 +13882,169 @@ type OrderLine implements Node & ObjectWithMetadata @doc(category: "Orders") {
"""
metafields(keys: [String!]): Metadata
- """Name of the product in order line."""
- productName: String!
-
- """Name of the variant of product in order line."""
- variantName: String!
-
- """SKU of the product variant."""
- productSku: String
-
- """The ID of the product variant."""
- productVariantId: String
-
- """Whether the product variant requires shipping."""
- isShippingRequired: Boolean!
-
- """Number of variant items ordered."""
- quantity: Int!
-
- """Number of variant items fulfilled."""
- quantityFulfilled: Int!
-
- """Rate of tax applied on product variant."""
- 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.
- """
- format: ThumbnailFormatEnum = ORIGINAL
- ): Image
-
- """
- Price of the single item in the order line with all the line-level discounts and order-level discount portions applied.
- """
- unitPrice: TaxedMoney!
-
- """
- Price of the single item in the order line without any discount applied.
- """
- undiscountedUnitPrice: TaxedMoney!
-
- """
- Sum of the line-level discounts applied to the order line. Order-level discounts which affect the line are not visible in this field. For order-level discount portion (if any), please query `order.discounts` field.
- """
- unitDiscount: Money!
-
- """
- Reason for line-level discounts applied on the order line. Order-level discounts which affect the line are not visible in this field. For order-level discount reason (if any), please query `order.discounts` field.
- """
- unitDiscountReason: String
-
- """
- Value of the discount. Can store fixed value or percent value. This field shouldn't be used when multiple discounts affect the line. There is a limitation, that after running `checkoutComplete` mutation the field always stores fixed value.
- """
- unitDiscountValue: PositiveDecimal!
-
- """
- Type of the discount: `fixed` or `percent`. This field shouldn't be used when multiple discounts affect the line. There is a limitation, that after running `checkoutComplete` mutation the field is always set to `fixed`.
- """
- unitDiscountType: DiscountValueTypeEnum
-
- """Price of the order line."""
- totalPrice: TaxedMoney!
-
- """Price of the order line without discounts."""
- undiscountedTotalPrice: TaxedMoney!
-
- """Returns True, if the line unit price was overridden."""
- isPriceOverridden: Boolean
-
- """
- 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
+ """The name of the menu."""
+ name: String!
- """Product name in the customer's language"""
- translatedProductName: String!
+ """Slug of the menu."""
+ slug: String!
- """Variant name in the customer's language"""
- translatedVariantName: String!
+ """Menu items associated with this menu."""
+ items: [MenuItem!]
+}
- """
- List of allocations across warehouses.
-
- Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
- """
- allocations: [Allocation!]
+"""
+Represents promotion's original translatable fields and related translations.
+"""
+type PromotionTranslatableContent implements Node {
+ """ID of the promotion translatable content."""
+ id: ID!
- """
- Denormalized sale ID, set when order line is created for a product variant that is on sale.
- """
- saleId: ID
+ """ID of the promotion to translate."""
+ promotionId: ID!
- """A quantity of items remaining to be fulfilled."""
- quantityToFulfill: Int!
+ """Name of the promotion."""
+ name: String!
"""
- Denormalized tax class of the product in this order line.
+ Description of the promotion.
- Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ Rich text format. For reference see https://editorjs.io/
"""
- taxClass: TaxClass
+ description: JSONString
- """Denormalized name of the tax class."""
- taxClassName: String
+ """Returns translated promotion fields for the given language code."""
+ translation(
+ """A language code to return the translation for promotion."""
+ languageCode: LanguageCodeEnum!
+ ): PromotionTranslation
+}
- """Denormalized public metadata of the tax class."""
- taxClassMetadata: [MetadataItem!]!
+"""Represents promotion translations."""
+type PromotionTranslation implements Node {
+ """ID of the promotion translation."""
+ id: ID!
- """
- Denormalized private metadata of the tax class. Requires staff permissions to access.
- """
- taxClassPrivateMetadata: [MetadataItem!]!
+ """Translation language."""
+ language: LanguageDisplay!
- """Voucher code that was used for this order line."""
- voucherCode: String
+ """Translated name of the promotion."""
+ name: String
"""
- Determine if the line is a gift.
-
- Added in Saleor 3.19.
+ Translated description of the promotion.
- Note: this API is currently in Feature Preview and can be subject to changes at later point.
+ Rich text format. For reference see https://editorjs.io/
"""
- isGift: Boolean
+ description: JSONString
- """
- List of applied discounts
-
- Added in Saleor 3.21.
- """
- discounts: [OrderLineDiscount!]
+ """Represents the promotion fields to translate."""
+ translatableContent: PromotionTranslatableContent
}
"""
-Nonnegative Decimal scalar implementation.
-
-Should be used in places where value must be nonnegative (0 or greater).
+Represents promotion rule's original translatable fields and related translations.
"""
-scalar PositiveDecimal
-
-"""Represents allocation."""
-type Allocation implements Node @doc(category: "Products") {
- """The ID of allocation."""
+type PromotionRuleTranslatableContent implements Node {
+ """ID of the promotion rule translatable content."""
id: ID!
- """
- Quantity allocated for orders.
-
- Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
- """
- quantity: Int!
+ """ID of the promotion rule to translate."""
+ promotionRuleId: ID!
+
+ """Name of the promotion rule."""
+ name: String
"""
- The warehouse were items were allocated.
+ Description of the promotion rule.
- Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
+ Rich text format. For reference see https://editorjs.io/
"""
- warehouse: Warehouse!
+ description: JSONString
+
+ """Returns translated promotion rule fields for the given language code."""
+ translation(
+ """A language code to return the translation for promotion rule."""
+ languageCode: LanguageCodeEnum!
+ ): PromotionRuleTranslation
}
-"""Represent the discount applied to order line."""
-type OrderLineDiscount @doc(category: "Orders") {
- """The ID of discount applied."""
+"""Represents promotion rule translations."""
+type PromotionRuleTranslation implements Node {
+ """ID of the promotion rule translation."""
id: ID!
- """The type of applied discount: Sale, Voucher or Manual."""
- type: OrderDiscountType!
+ """Translation language."""
+ language: LanguageDisplay!
- """The name of applied discount."""
+ """Translated name of the promotion rule."""
name: String
- """Translated name of the applied discount."""
- 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.
+ Translated description of the promotion rule.
- Requires one of the following permissions: MANAGE_ORDERS.
+ Rich text format. For reference see https://editorjs.io/
"""
- reason: String
-
- """The discount amount applied to the line item."""
- total: Money!
-
- """The discount amount applied to the single line unit."""
- unit: Money!
-}
+ description: JSONString
-enum OrderDiscountType @doc(category: "Discounts") {
- SALE
- VOUCHER
- MANUAL
- PROMOTION
- ORDER_PROMOTION
+ """Represents the promotion rule fields to translate."""
+ translatableContent: PromotionRuleTranslatableContent
}
-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 sale's original translatable fields and related translations.
-"""Represents an Invoice."""
-type Invoice implements ObjectWithMetadata & Job & Node @doc(category: "Orders") {
- """List of private metadata items. Requires staff permissions to access."""
- privateMetadata: [MetadataItem!]!
+DEPRECATED: this type will be removed. Use `PromotionTranslatableContent` instead.
+"""
+type SaleTranslatableContent implements Node {
+ """The ID of the sale translatable content."""
+ id: ID!
- """
- A single key from private metadata. Requires staff permissions to access.
-
- Tip: Use GraphQL aliases to fetch multiple keys.
- """
- privateMetafield(key: String!): String
+ """The ID of the sale to translate."""
+ saleId: ID!
- """
- 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
+ """Name of the sale to translate."""
+ name: String!
- """List of public metadata items. Can be accessed without permissions."""
- metadata: [MetadataItem!]!
+ """Returns translated sale fields for the given language code."""
+ translation(
+ """A language code to return the translation for sale."""
+ languageCode: LanguageCodeEnum!
+ ): SaleTranslation
"""
- A single key from public metadata.
+ Sales allow creating discounts for categories, collections or products and are visible to all the customers.
- 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.
+ Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
- metafields(keys: [String!]): Metadata
-
- """Job status."""
- status: JobStatusEnum!
-
- """Date and time at which invoice was created."""
- createdAt: DateTime!
-
- """Date and time at which invoice was updated."""
- updatedAt: DateTime!
-
- """Message associated with an invoice."""
- message: String
-
- """The ID of the object."""
- id: ID!
-
- """Invoice number."""
- number: String
-
- """URL to view an invoice."""
- externalUrl: String @deprecated(reason: "Use `url` field.")
-
- """URL to view/download an invoice."""
- url: String
-
- """Order related to the invoice."""
- 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
-}
-
-enum JobStatusEnum {
- PENDING
- SUCCESS
- FAILED
- DELETED
-}
-
-enum OrderOriginEnum @doc(category: "Orders") {
- CHECKOUT
- DRAFT
- REISSUE
- BULK_CREATE
-}
-
-enum PaymentChargeStatusEnum @doc(category: "Payments") {
- NOT_CHARGED
- PENDING
- PARTIALLY_CHARGED
- FULLY_CHARGED
- PARTIALLY_REFUNDED
- FULLY_REFUNDED
- REFUSED
- CANCELLED
+ sale: Sale @deprecated(reason: "Get model fields from the root level queries.")
}
"""
-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.
+Represents sale translations.
- 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`
+DEPRECATED: this type will be removed. Use `PromotionTranslation` instead.
"""
-enum OrderAuthorizeStatusEnum @doc(category: "Orders") {
- NONE
- PARTIAL
- FULL
-}
+type SaleTranslation implements Node {
+ """The ID of the sale translation."""
+ id: ID!
-"""
-Determine the current charge status for the order.
+ """Translation language."""
+ language: LanguageDisplay!
- 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.
+ """Translated name of sale."""
+ name: String
- 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 the sale fields to translate."""
+ translatableContent: SaleTranslatableContent
}
-"""Represents a payment of a given type."""
-type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") {
- """ID of the payment."""
+"""
+Sales allow creating discounts for categories, collections or products and are visible to all the customers.
+
+DEPRECATED: this type will be removed. Use `Promotion` type instead.
+"""
+type Sale implements Node & ObjectWithMetadata {
+ """The ID of the sale."""
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -12039,879 +14077,554 @@ type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") {
"""
metafields(keys: [String!]): Metadata
- """Payment gateway used for payment."""
- gateway: String!
+ """The name of the sale."""
+ name: String!
- """Determines if the payment is active or not."""
- isActive: Boolean!
+ """Type of the sale, fixed or percentage."""
+ type: SaleType!
- """Date and time at which payment was created."""
- created: DateTime!
+ """The start date and time of the sale."""
+ startDate: DateTime!
- """Date and time at which payment was modified."""
- modified: DateTime!
+ """The end date and time of the sale."""
+ endDate: DateTime
- """Unique token associated with a payment."""
- token: String!
+ """The date and time when the sale was created."""
+ created: DateTime!
- """Checkout associated with a payment."""
- checkout: Checkout
+ """The date and time when the sale was updated."""
+ updatedAt: DateTime!
- """Order associated with a payment."""
- order: Order
+ """List of categories this sale applies to."""
+ categories(
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """Type of method used for payment."""
- paymentMethodType: String!
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """
- IP address of the user who created the payment.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- customerIpAddress: 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
- """Internal payment status."""
- chargeStatus: PaymentChargeStatusEnum!
+ """
+ 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 actions that can be performed in the current state of a payment.
+ List of collections this sale applies to.
- Requires one of the following permissions: MANAGE_ORDERS.
+ Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
- actions: [OrderAction!]!
-
- """Total amount of the payment."""
- total: Money
+ collections(
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """Total amount captured for this payment."""
- capturedAmount: Money
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """
- List of all transactions within this payment.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- transactions: [Transaction!]
+ """
+ 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
- """
- Maximum amount of money that can be captured.
-
- Requires one of the following permissions: MANAGE_ORDERS.
- """
- availableCaptureAmount: Money
+ """
+ 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
"""
- Maximum amount of money that can be refunded.
+ List of products this sale applies to.
- Requires one of the following permissions: MANAGE_ORDERS.
+ Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
- availableRefundAmount: Money
-
- """The details of the card used for this payment."""
- creditCard: CreditCard
+ products(
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """Informs whether this is a partial payment."""
- partial: Boolean!
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """PSP reference of the payment."""
- pspReference: 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
-"""An object representing a single payment."""
-type Transaction implements Node @doc(category: "Payments") {
- """ID of the transaction."""
- id: ID!
+ """
+ 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
- """Date and time at which transaction was created."""
- created: DateTime!
+ """
+ List of product variants this sale applies to.
+
+ Requires one of the following permissions: MANAGE_DISCOUNTS.
+ """
+ variants(
+ """Return the elements in the list that come before the specified cursor."""
+ before: String
- """Determines the payment associated with a transaction."""
- payment: Payment!
+ """Return the elements in the list that come after the specified cursor."""
+ after: String
- """Unique token associated with a transaction."""
- token: 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
- """Determines the type of transaction."""
- kind: TransactionKind!
+ """
+ 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
- """Determines if the transaction was successful."""
- isSuccess: Boolean!
+ """Returns translated sale fields for the given language code."""
+ translation(
+ """A language code to return the translation for sale."""
+ languageCode: LanguageCodeEnum!
+ ): SaleTranslation
- """Error associated with transaction, if any."""
- error: String
+ """
+ List of channels available for the sale.
+
+ Requires one of the following permissions: MANAGE_DISCOUNTS.
+ """
+ channelListings: [SaleChannelListing!]
- """Response returned by payment gateway."""
- gatewayResponse: JSONString! @deprecated(reason: "This field is a part of a legacy Payments API. Please use apps instead.")
+ """Sale value."""
+ discountValue: Float
- """Total amount of the transaction."""
- amount: Money
+ """Currency code for sale."""
+ currency: String
}
-enum TransactionKind @doc(category: "Payments") {
- EXTERNAL
- AUTH
- PENDING
- ACTION_TO_CONFIRM
- REFUND
- REFUND_ONGOING
- CAPTURE
- VOID
- CONFIRM
- CANCEL
+enum SaleType {
+ FIXED
+ PERCENTAGE
}
-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
-}
+"""
+Represents sale channel listing.
-"""History log of the order."""
-type OrderEvent implements Node @doc(category: "Orders") {
- """ID of the event associated with an order."""
+DEPRECATED: this type will be removed. Use `PromotionRule` type instead.
+"""
+type SaleChannelListing implements Node {
+ """The ID of the channel listing."""
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 order event which is related to this event."""
- related: OrderEvent
-
- """The discount applied to the order."""
- discount: OrderEventDiscountObject
+ """The channel in which the sale is available."""
+ channel: Channel!
- """The reference of payment's transaction."""
- reference: String
-}
+ """The value of the discount applied to the sale in the channel."""
+ discountValue: Float!
-"""The different order event types."""
-enum OrderEventsEnum @doc(category: "Orders") {
- DRAFT_CREATED
- DRAFT_CREATED_FROM_REPLACE
- ADDED_PRODUCTS
- REMOVED_PRODUCTS
- PLACED
- PLACED_FROM_DRAFT
- PLACED_AUTOMATICALLY_FROM_PAID_CHECKOUT
- 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
- TRANSACTION_REFUND_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
- NOTE_UPDATED
- OTHER
+ """The currency in which the discount value is specified."""
+ currency: String!
}
-enum OrderEventsEmailsEnum @doc(category: "Orders") {
- PAYMENT_CONFIRMATION
- CONFIRMED
- SHIPPING_CONFIRMATION
- TRACKING_UPDATED
- ORDER_CONFIRMATION
- ORDER_CANCEL
- ORDER_REFUND
- FULFILLMENT_CONFIRMATION
- DIGITAL_LINKS
+enum TranslatableKinds {
+ ATTRIBUTE
+ ATTRIBUTE_VALUE
+ CATEGORY
+ COLLECTION
+ MENU_ITEM
+ PAGE
+ PRODUCT
+ PROMOTION
+ PROMOTION_RULE
+ SALE
+ SHIPPING_METHOD
+ VARIANT
+ VOUCHER
}
-type OrderEventOrderLineObject @doc(category: "Orders") {
- """The variant quantity."""
- quantity: Int
-
- """The order line."""
- orderLine: OrderLine
-
- """The variant name."""
- itemName: String
+type TaxConfigurationCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [TaxConfigurationCountableEdge!]!
- """The discount applied to the order line."""
- discount: OrderEventDiscountObject
+ """A total count of items in the collection."""
+ totalCount: Int
}
-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
+type TaxConfigurationCountableEdge {
+ """The item at the end of the edge."""
+ node: TaxConfiguration!
- """Returns amount of discount."""
- oldAmount: Money
+ """A cursor for use in pagination."""
+ cursor: String!
}
-"""Contains all details related to the applied discount to the order."""
-type OrderDiscount implements Node @doc(category: "Discounts") {
- """The ID of discount applied."""
- id: ID!
-
- """The type of applied discount: Sale, Voucher or Manual."""
- type: OrderDiscountType!
-
- """The name of applied discount."""
- name: String
-
- """Translated name of the applied discount."""
- 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! @deprecated(reason: "Use `total` instead.")
-
- """
- The amount of discount applied to the order.
-
- Added in Saleor 3.21.
- """
- total: Money!
+input TaxConfigurationFilterInput {
+ metadata: [MetadataFilter!]
+ ids: [ID!]
}
-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
+type TaxClassCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [TaxClassCountableEdge!]!
- """The error code."""
- code: OrderErrorCode!
+ """A total count of items in the collection."""
+ totalCount: Int
+}
- """Warehouse ID which causes the error."""
- warehouse: ID
+type TaxClassCountableEdge {
+ """The item at the end of the edge."""
+ node: TaxClass!
- """List of order line IDs that cause the error."""
- orderLines: [ID!]
+ """A cursor for use in pagination."""
+ cursor: String!
+}
- """List of product variants that are associated with the error"""
- variants: [ID!]
+input TaxClassSortingInput {
+ """Specifies the direction in which to sort tax classes."""
+ direction: OrderDirection!
- """A type of address that causes the error."""
- addressType: AddressTypeEnum
+ """Sort tax classes by the selected field."""
+ field: TaxClassSortField!
}
-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
- INVALID_VOUCHER
- INVALID_VOUCHER_CODE
- NON_EDITABLE_GIFT_LINE
- NON_REMOVABLE_GIFT_LINE
- MISSING_ADDRESS_DATA
+enum TaxClassSortField {
+ """Sort tax classes by name."""
+ NAME
}
-enum AddressTypeEnum {
- BILLING
- SHIPPING
+input TaxClassFilterInput {
+ metadata: [MetadataFilter!]
+ ids: [ID!]
+ countries: [CountryCode!]
}
-"""The details of granted refund."""
-type OrderGrantedRefund @doc(category: "Orders") {
- id: ID!
-
- """Time of creation."""
- createdAt: DateTime!
+"""Tax class rates grouped by country."""
+type TaxCountryConfiguration {
+ """A country for which tax class rates are grouped."""
+ country: CountryDisplay!
- """Time of last update."""
- updatedAt: DateTime!
+ """List of tax class rates."""
+ taxClassCountryRates: [TaxClassCountryRate!]!
+}
- """Refund amount."""
- amount: Money!
+input StockFilterInput {
+ quantity: Float
+ search: String
+}
- """
- Reason of the refund.
-
- Added in Saleor 3.22.
- """
- reason: String
+"""
+Represents a shop resource containing general shop data and configuration.
+"""
+type Shop implements ObjectWithMetadata {
+ """List of private metadata items. Requires staff permissions to access."""
+ privateMetadata: [MetadataItem!]!
"""
- Reason Model (Page) reference for refund.
+ A single key from private metadata. Requires staff permissions to access.
- Added in Saleor 3.22.
- """
- reasonReference: Page
-
- """
- User who performed the action. Requires of of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER.
+ Tip: Use GraphQL aliases to fetch multiple keys.
"""
- user: User
-
- """App that performed the action."""
- app: App
+ privateMetafield(key: String!): String
"""
- If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price.
+ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
"""
- shippingCostsIncluded: Boolean!
-
- """Lines assigned to the granted refund."""
- lines: [OrderGrantedRefundLine!]
+ privateMetafields(keys: [String!]): Metadata
- """
- Status of the granted refund calculated based on transactionItem assigned to granted refund.
-
- Added in Saleor 3.20.
- """
- status: OrderGrantedRefundStatusEnum!
+ """List of public metadata items. Can be accessed without permissions."""
+ metadata: [MetadataItem!]!
"""
- List of refund events associated with the granted refund.
+ A single key from public metadata.
- Added in Saleor 3.20.
+ Tip: Use GraphQL aliases to fetch multiple keys.
"""
- transactionEvents: [TransactionEvent!]
+ metafield(key: String!): String
"""
- The transaction assigned to the granted refund.
-
- Added in Saleor 3.20.
+ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
"""
- transaction: TransactionItem
-}
+ metafields(keys: [String!]): Metadata
-"""Represents granted refund line."""
-type OrderGrantedRefundLine {
+ """ID of the shop."""
id: ID!
- """Number of items to refund."""
- quantity: Int!
+ """List of available payment gateways."""
+ availablePaymentGateways(
+ """
+ A currency for which gateways will be returned.
+
+ DEPRECATED: this field will be removed. Use `channel` argument instead.
+ """
+ currency: String
- """Line of the order associated with this granted refund."""
- orderLine: OrderLine!
+ """Slug of a channel for which the data should be returned."""
+ channel: String
+ ): [PaymentGateway!]!
- """Reason for refunding the line."""
- reason: String
-}
+ """List of available external authentications."""
+ availableExternalAuthentications: [ExternalAuthentication!]!
-"""
-Represents the status of a granted refund.
+ """Shipping methods that are available for the shop."""
+ availableShippingMethods(
+ """Slug of a channel for which the data should be returned."""
+ channel: String!
- NONE - the refund on related transactionItem is not processed
- PENDING - the refund on related transactionItem is pending
- FULL - the refund on related transactionItem is fully processed
- FAIL - the refund on related transactionItem failed
-"""
-enum OrderGrantedRefundStatusEnum @doc(category: "Orders") {
- NONE
- PENDING
- SUCCESS
- FAILURE
-}
+ """Address for which available shipping methods should be returned."""
+ address: AddressInput
+ ): [ShippingMethod!]
-"""Represents transaction's event."""
-type TransactionEvent implements Node @doc(category: "Payments") {
- """The ID of the object."""
- id: ID!
+ """
+ List of all currencies supported by shop's channels.
+
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ """
+ channelCurrencies: [String!]!
- """Date and time at which a transaction event was created."""
- createdAt: DateTime!
+ """List of countries available in the shop."""
+ countries(
+ """
+ A language code to return the translation for.
+
+ DEPRECATED: this field will be removed.
+ """
+ languageCode: LanguageCodeEnum
- """PSP reference of transaction."""
- pspReference: String!
+ """Filtering options for countries"""
+ filter: CountryFilterInput
+ ): [CountryDisplay!]!
- """Message related to the transaction's event."""
- message: String!
+ """Shop's default country."""
+ defaultCountry: CountryDisplay
"""
- Reason model of the transaction refund.
+ Default shop's email sender's name.
- Added in Saleor 3.22.
+ Requires one of the following permissions: MANAGE_SETTINGS.
"""
- reasonReference: Page
+ defaultMailSenderName: String
"""
- The url that will allow to redirect user to payment provider page with transaction details.
+ Default shop's email sender's address.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
"""
- externalUrl: String!
-
- """The amount related to this event."""
- amount: Money!
-
- """The type of action related to this event."""
- type: TransactionEventTypeEnum
-
- """User or App that created the transaction event."""
- createdBy: UserOrApp
-
- """Idempotency key assigned to the event."""
- idempotencyKey: String
-}
+ defaultMailSenderAddress: String
-"""
-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
-}
+ """Shop's description."""
+ description: String
-union UserOrApp = User | App
+ """Shop's domain data."""
+ domain: Domain!
-"""
-Represents a payment method used for a transaction.
+ """List of the shops's supported languages."""
+ languages: [LanguageDisplay!]!
-Added in Saleor 3.22.
-"""
-interface PaymentMethodDetails {
- """Name of the payment method."""
+ """Shop's name."""
name: String!
-}
-
-"""
-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.
+ """List of available permissions."""
+ permissions: [Permission!]!
- 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
-}
+ """List of possible phone prefixes."""
+ phonePrefixes: [String!]!
-"""
-Determine the current charge status for the checkout.
+ """Header text."""
+ headerText: String
- 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.
+ """Automatically approve all new fulfillments."""
+ fulfillmentAutoApprove: Boolean!
+ """Allow to approve fulfillments which are unpaid."""
+ fulfillmentAllowUnpaid: Boolean!
- 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
-}
+ """
+ This field is used as a default value for `ProductVariant.trackInventory`.
+ """
+ trackInventoryByDefault: Boolean
-"""
-Represents a payment method stored for user (tokenized) in payment gateway.
-"""
-type StoredPaymentMethod @doc(category: "Payments") {
- """Stored payment method ID."""
- id: ID!
+ """Default weight unit."""
+ defaultWeightUnit: WeightUnitsEnum
- """Payment gateway that stores this payment method."""
- gateway: PaymentGateway!
+ """Returns translated shop fields for the given language code."""
+ translation(
+ """A language code to return the translation for shop."""
+ languageCode: LanguageCodeEnum!
+ ): ShopTranslation
"""
- ID of stored payment method used to make payment actions. Note: method ID is unique only within the payment gateway.
+ Enable automatic fulfillment for all digital products.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
"""
- paymentMethodId: String!
-
- """Stored credit card details if available."""
- creditCardInfo: CreditCard
- supportedPaymentFlows: [TokenizedPaymentFlowEnum!]
+ automaticFulfillmentDigitalProducts: Boolean
- """Type of the payment method. Example: credit card, wallet, etc."""
- type: String!
+ """
+ Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ reserveStockDurationAnonymousUser: Int
"""
- Payment method name. Example: last 4 digits of credit card, obfuscated email, etc.
+ Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
"""
- name: String
+ reserveStockDurationAuthenticatedUser: Int
- """JSON data returned by Payment Provider app for this payment method."""
- data: JSON
-}
+ """
+ Default number of maximum line quantity in single checkout (per single checkout line).
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ limitQuantityPerCheckout: Int
-"""
-Represents possible tokenized payment flows that can be used to process payment.
+ """
+ Default number of max downloads per digital content URL.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ defaultDigitalMaxDownloads: Int
- The following flows are possible:
- INTERACTIVE - Payment method can be used for 1 click checkout - it's prefilled in
- checkout form (might require additional authentication from user)
-"""
-enum TokenizedPaymentFlowEnum @doc(category: "Payments") {
- INTERACTIVE
-}
+ """
+ Default number of days which digital content URL will be valid.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ defaultDigitalUrlValidDays: Int
-"""Represents an problem in the checkout."""
-union CheckoutProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable
+ """Company address."""
+ companyAddress: Address
-type CheckoutCountableConnection @doc(category: "Checkout") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [CheckoutCountableEdge!]!
+ """URL of a view where customers can set their password."""
+ customerSetPasswordUrl: String
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """
+ List of staff notification recipients.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ staffNotificationRecipients: [StaffNotificationRecipient!]
-type CheckoutCountableEdge @doc(category: "Checkout") {
- """The item at the end of the edge."""
- node: Checkout!
+ """
+ Determines if account confirmation by email is enabled.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ enableAccountConfirmationByEmail: Boolean
- """A cursor for use in pagination."""
- cursor: String!
-}
+ """
+ Determines if user can login without confirmation when `enableAccountConfirmation` is enabled.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ allowLoginWithoutConfirmation: Boolean
-type GiftCardCountableConnection @doc(category: "Gift cards") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [GiftCardCountableEdge!]!
+ """
+ Resource limitations and current usage if any set for a shop
+
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
+ """
+ limits: LimitInfo! @deprecated
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """
+ Saleor API version.
+
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ """
+ version: String!
-type GiftCardCountableEdge @doc(category: "Gift cards") {
- """The item at the end of the edge."""
- node: GiftCard!
+ """Minor Saleor API version."""
+ schemaVersion: String!
- """A cursor for use in pagination."""
- cursor: String!
-}
+ """
+ List of tax apps that can be assigned to the channel. The list will be calculated by Saleor based on the apps that are subscribed to webhooks related to tax calculations: CHECKOUT_CALCULATE_TAXES
+
+ Added in Saleor 3.19.
+
+ Requires one of the following permissions: AUTHENTICATED_STAFF_USER, MANAGE_APPS.
+ """
+ availableTaxApps: [App!]!
-type OrderCountableConnection @doc(category: "Orders") {
- """Pagination data for this connection."""
- pageInfo: PageInfo!
- edges: [OrderCountableEdge!]!
+ """Include taxes in prices."""
+ includeTaxesInPrices: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax.")
- """A total count of items in the collection."""
- totalCount: Int
-}
+ """Display prices with tax in store."""
+ displayGrossPrices: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration` to determine whether to display gross or net prices.")
-type OrderCountableEdge @doc(category: "Orders") {
- """The item at the end of the edge."""
- node: Order!
+ """Charge taxes on shipping."""
+ chargeTaxesOnShipping: Boolean! @deprecated(reason: "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.")
- """A cursor for use in pagination."""
- cursor: String!
+ """
+ Use legacy update webhook emission. When enabled, update webhooks (e.g. `customerUpdated`,`productVariantUpdated`) are sent even when only metadata changes. When disabled, update webhooks are not sent for metadata-only changes; only metadata-specific webhooks (e.g., `customerMetadataUpdated`, `productVariantMetadataUpdated`) are sent.
+
+ Added in Saleor 3.22.
+ """
+ useLegacyUpdateWebhookEmission: Boolean @deprecated
}
-"""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!
+"""External authentication plugin."""
+type ExternalAuthentication {
+ """ID of external authentication plugin."""
+ id: String!
- """List of user permission groups which contains this permission."""
- sourcePermissionGroups(
- """ID of user whose groups should be returned."""
- userId: ID!
- ): [Group!]
+ """Name of external authentication plugin."""
+ name: String
}
-"""Represents permission group data."""
-type Group implements Node @doc(category: "Users") {
- """The ID of the group."""
- id: ID!
-
- """The name of the group."""
- name: String!
-
+input CountryFilterInput {
"""
- List of group users
-
- Requires one of the following permissions: MANAGE_STAFF.
+ 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.
"""
- users: [User!]
-
- """List of group permissions"""
- permissions: [Permission!]
+ attachedToShippingZones: Boolean
+}
- """
- True, if the currently authenticated user has rights to manage a group.
- """
- userCanManage: Boolean!
+"""Represents API domain."""
+type Domain {
+ """The host name of the domain."""
+ host: String!
- """List of channels the group has access to."""
- accessibleChannels: [Channel!]
+ """Inform if SSL is enabled."""
+ sslEnabled: Boolean!
- """Determine if the group have restricted access to channels."""
- restrictedAccessToChannels: Boolean!
+ """The absolute URL of the API."""
+ url: String!
}
-"""History log of the customer."""
-type CustomerEvent implements Node @doc(category: "Users") {
- """The ID of the customer event."""
+"""Represents shop translations."""
+type ShopTranslation implements Node {
+ """The ID of the shop translation."""
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
+ """Translation language."""
+ language: LanguageDisplay!
- """The concerned order line."""
- orderLine: OrderLine
-}
+ """Translated header text of sale."""
+ headerText: String!
-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
+ """Translated description of sale."""
+ description: String!
}
"""
-Represents a payment source stored for user in payment gateway, such as credit card.
+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 PaymentSource @doc(category: "Payments") {
- """Payment gateway name."""
- gateway: String!
+type StaffNotificationRecipient implements Node {
+ """The ID of the staff notification recipient."""
+ id: ID!
- """ID of stored payment method."""
- paymentMethodId: String
+ """Returns a user subscribed to email notifications."""
+ user: User
- """Stored credit card details if available."""
- creditCardInfo: CreditCard
+ """Returns email address of a user subscribed to email notifications."""
+ email: String
- """
- List of public metadata items.
-
- Can be accessed without permissions.
- """
- metadata: [MetadataItem!]!
+ """Determines if a notification active."""
+ active: Boolean
}
"""Store the current and allowed usage."""
@@ -12941,7 +14654,7 @@ type Limits {
}
"""Gift card related settings from site settings."""
-type GiftCardSettings @doc(category: "Gift cards") {
+type GiftCardSettings {
"""The gift card expiry type settings."""
expiryType: GiftCardSettingsExpiryTypeEnum!
@@ -12949,7 +14662,7 @@ type GiftCardSettings @doc(category: "Gift cards") {
expiryPeriod: TimePeriod
}
-enum GiftCardSettingsExpiryTypeEnum @doc(category: "Gift cards") {
+enum GiftCardSettingsExpiryTypeEnum {
NEVER_EXPIRE
EXPIRY_PERIOD
}
@@ -12974,18 +14687,28 @@ Refund related settings from site settings.
Added in Saleor 3.22.
"""
-type RefundSettings @doc(category: "Orders") {
+type RefundSettings {
"""Model type used for refund reasons."""
reasonReferenceType: PageType
}
-input ShippingZoneFilterInput @doc(category: "Shipping") {
+"""
+Return related settings from site settings.
+
+Added in Saleor 3.22.
+"""
+type ReturnSettings {
+ """Model type used for return reasons."""
+ reasonReferenceType: PageType
+}
+
+input ShippingZoneFilterInput {
search: String
channels: [ID!]
}
"""A connection to a list of digital content items."""
-type DigitalContentCountableConnection @doc(category: "Products") {
+type DigitalContentCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [DigitalContentCountableEdge!]!
@@ -12994,7 +14717,7 @@ type DigitalContentCountableConnection @doc(category: "Products") {
totalCount: Int
}
-type DigitalContentCountableEdge @doc(category: "Products") {
+type DigitalContentCountableEdge {
"""The item at the end of the edge."""
node: DigitalContent!
@@ -13002,7 +14725,7 @@ type DigitalContentCountableEdge @doc(category: "Products") {
cursor: String!
}
-input CategoryFilterInput @doc(category: "Products") {
+input CategoryFilterInput {
search: String
metadata: [MetadataFilter!]
ids: [ID!]
@@ -13012,7 +14735,7 @@ input CategoryFilterInput @doc(category: "Products") {
updatedAt: DateTimeRangeInput
}
-input CategoryWhereInput @doc(category: "Products") {
+input CategoryWhereInput {
metadata: [MetadataFilter!]
ids: [ID!]
@@ -13023,18 +14746,22 @@ input CategoryWhereInput @doc(category: "Products") {
OR: [CategoryWhereInput!]
}
-input CategorySortingInput @doc(category: "Products") {
+input CategorySortingInput {
"""Specifies the direction in which to sort categories."""
direction: OrderDirection!
- """Specifies the channel in which to sort the data."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
+ """
+ Specifies the channel in which to sort the data.
+
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ """
+ channel: String
"""Sort categories by the selected field."""
field: CategorySortField!
}
-enum CategorySortField @doc(category: "Products") {
+enum CategorySortField {
"""Sort categories by name."""
NAME
@@ -13045,23 +14772,27 @@ enum CategorySortField @doc(category: "Products") {
SUBCATEGORY_COUNT
}
-input CollectionFilterInput @doc(category: "Products") {
+input CollectionFilterInput {
published: CollectionPublished
search: String
metadata: [MetadataFilter!]
ids: [ID!]
slugs: [String!]
- """Specifies the channel by which the data should be filtered."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
+ """
+ Specifies the channel by which the data should be filtered.
+
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ """
+ channel: String
}
-enum CollectionPublished @doc(category: "Products") {
+enum CollectionPublished {
PUBLISHED
HIDDEN
}
-input CollectionWhereInput @doc(category: "Products") {
+input CollectionWhereInput {
metadata: [MetadataFilter!]
ids: [ID!]
@@ -13072,18 +14803,22 @@ input CollectionWhereInput @doc(category: "Products") {
OR: [CollectionWhereInput!]
}
-input CollectionSortingInput @doc(category: "Products") {
+input CollectionSortingInput {
"""Specifies the direction in which to sort collections."""
direction: OrderDirection!
- """Specifies the channel in which to sort the data."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
+ """
+ Specifies the channel in which to sort the data.
+
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ """
+ channel: String
"""Sort collections by the selected field."""
field: CollectionSortField!
}
-enum CollectionSortField @doc(category: "Products") {
+enum CollectionSortField {
"""Sort collections by name."""
NAME
@@ -13112,7 +14847,7 @@ enum CollectionSortField @doc(category: "Products") {
PUBLISHED_AT
}
-input ProductTypeFilterInput @doc(category: "Products") {
+input ProductTypeFilterInput {
search: String
configurable: ProductTypeConfigurable
productType: ProductTypeEnum
@@ -13122,17 +14857,17 @@ input ProductTypeFilterInput @doc(category: "Products") {
slugs: [String!]
}
-enum ProductTypeConfigurable @doc(category: "Products") {
+enum ProductTypeConfigurable {
CONFIGURABLE
SIMPLE
}
-enum ProductTypeEnum @doc(category: "Products") {
+enum ProductTypeEnum {
DIGITAL
SHIPPABLE
}
-input ProductTypeSortingInput @doc(category: "Products") {
+input ProductTypeSortingInput {
"""Specifies the direction in which to sort product types."""
direction: OrderDirection!
@@ -13140,7 +14875,7 @@ input ProductTypeSortingInput @doc(category: "Products") {
field: ProductTypeSortField!
}
-enum ProductTypeSortField @doc(category: "Products") {
+enum ProductTypeSortField {
"""Sort products by name."""
NAME
@@ -13151,7 +14886,7 @@ enum ProductTypeSortField @doc(category: "Products") {
SHIPPING_REQUIRED
}
-type PaymentCountableConnection @doc(category: "Payments") {
+type PaymentCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PaymentCountableEdge!]!
@@ -13160,7 +14895,7 @@ type PaymentCountableConnection @doc(category: "Payments") {
totalCount: Int
}
-type PaymentCountableEdge @doc(category: "Payments") {
+type PaymentCountableEdge {
"""The item at the end of the edge."""
node: Payment!
@@ -13168,13 +14903,46 @@ type PaymentCountableEdge @doc(category: "Payments") {
cursor: String!
}
-input PaymentFilterInput @doc(category: "Payments") {
+input PaymentFilterInput {
"""Filter by ids."""
ids: [ID!]
checkouts: [ID!]
}
-type PageCountableConnection @doc(category: "Pages") {
+type TransactionCountableConnection {
+ """Pagination data for this connection."""
+ pageInfo: PageInfo!
+ edges: [TransactionCountableEdge!]!
+
+ """A total count of items in the collection."""
+ totalCount: Int
+}
+
+type TransactionCountableEdge {
+ """The item at the end of the edge."""
+ node: TransactionItem!
+
+ """A cursor for use in pagination."""
+ cursor: String!
+}
+
+input TransactionWhereInput {
+ ids: [ID!]
+
+ """Filter by PSP reference."""
+ pspReference: StringFilterInput
+
+ """Filter by app identifier."""
+ appIdentifier: StringFilterInput
+
+ """List of conditions that must be met."""
+ AND: [TransactionWhereInput!]
+
+ """A list of conditions of which at least one must be met."""
+ OR: [TransactionWhereInput!]
+}
+
+type PageCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PageCountableEdge!]!
@@ -13183,7 +14951,7 @@ type PageCountableConnection @doc(category: "Pages") {
totalCount: Int
}
-type PageCountableEdge @doc(category: "Pages") {
+type PageCountableEdge {
"""The item at the end of the edge."""
node: Page!
@@ -13191,7 +14959,7 @@ type PageCountableEdge @doc(category: "Pages") {
cursor: String!
}
-input PageSortingInput @doc(category: "Pages") {
+input PageSortingInput {
"""Specifies the direction in which to sort pages."""
direction: OrderDirection!
@@ -13199,7 +14967,7 @@ input PageSortingInput @doc(category: "Pages") {
field: PageSortField!
}
-enum PageSortField @doc(category: "Pages") {
+enum PageSortField {
"""Sort pages by title."""
TITLE
@@ -13222,7 +14990,7 @@ enum PageSortField @doc(category: "Pages") {
CREATED_AT
}
-input PageFilterInput @doc(category: "Pages") {
+input PageFilterInput {
search: String
metadata: [MetadataFilter!]
pageTypes: [ID!]
@@ -13230,7 +14998,7 @@ input PageFilterInput @doc(category: "Pages") {
slugs: [String!]
}
-input PageWhereInput @doc(category: "Pages") {
+input PageWhereInput {
"""Filter by metadata fields."""
metadata: MetadataFilterInput
ids: [ID!]
@@ -13251,17 +15019,7 @@ input PageWhereInput @doc(category: "Pages") {
OR: [PageWhereInput!]
}
-"""
-Allows filtering based on metadata key/value pairs.
-
- Examples:
- - `{key: "size"}`
- Matches objects where the metadata key "size" exists, regardless of its value.
- - `{key: "color", value: {oneOf: ["blue", "green"]}}`
- Matches objects where the metadata key "color" is set to either "blue" or "green".
- - `{key: "status", value: {eq: "active"}}`
- Matches objects where the metadata key "status" is set to "active".
-"""
+"Allows filtering based on metadata key/value pairs.\n\n Examples:\n - `{key: \"size\"}`\n Matches objects where the metadata key \"size\" exists, regardless of its value.\n - `{key: \"color\", value: {oneOf: [\"blue\", \"green\"]}}`\n Matches objects where the metadata key \"color\" is set to either \"blue\" or \"green\".\n - `{key: \"status\", value: {eq: \"active\"}}`\n Matches objects where the metadata key \"status\" is set to \"active\".\n "
input MetadataFilterInput {
"""
Key to filter by. If not other fields provided - checking the existence of the key in metadata.
@@ -13281,7 +15039,7 @@ input MetadataValueFilterInput {
oneOf: [String!]
}
-type PageTypeCountableConnection @doc(category: "Pages") {
+type PageTypeCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PageTypeCountableEdge!]!
@@ -13290,7 +15048,7 @@ type PageTypeCountableConnection @doc(category: "Pages") {
totalCount: Int
}
-type PageTypeCountableEdge @doc(category: "Pages") {
+type PageTypeCountableEdge {
"""The item at the end of the edge."""
node: PageType!
@@ -13298,7 +15056,7 @@ type PageTypeCountableEdge @doc(category: "Pages") {
cursor: String!
}
-input PageTypeSortingInput @doc(category: "Pages") {
+input PageTypeSortingInput {
"""Specifies the direction in which to sort page types."""
direction: OrderDirection!
@@ -13306,7 +15064,7 @@ input PageTypeSortingInput @doc(category: "Pages") {
field: PageTypeSortField!
}
-enum PageTypeSortField @doc(category: "Pages") {
+enum PageTypeSortField {
"""Sort page types by name."""
NAME
@@ -13314,12 +15072,12 @@ enum PageTypeSortField @doc(category: "Pages") {
SLUG
}
-input PageTypeFilterInput @doc(category: "Pages") {
+input PageTypeFilterInput {
search: String
slugs: [String!]
}
-type OrderEventCountableConnection @doc(category: "Orders") {
+type OrderEventCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [OrderEventCountableEdge!]!
@@ -13328,7 +15086,7 @@ type OrderEventCountableConnection @doc(category: "Orders") {
totalCount: Int
}
-type OrderEventCountableEdge @doc(category: "Orders") {
+type OrderEventCountableEdge {
"""The item at the end of the edge."""
node: OrderEvent!
@@ -13336,7 +15094,7 @@ type OrderEventCountableEdge @doc(category: "Orders") {
cursor: String!
}
-input OrderSortingInput @doc(category: "Orders") {
+input OrderSortingInput {
"""Specifies the direction in which to sort orders."""
direction: OrderDirection!
@@ -13344,7 +15102,7 @@ input OrderSortingInput @doc(category: "Orders") {
field: OrderSortField!
}
-enum OrderSortField @doc(category: "Orders") {
+enum OrderSortField {
"""Sort orders by number."""
NUMBER
@@ -13379,7 +15137,7 @@ enum OrderSortField @doc(category: "Orders") {
STATUS
}
-input OrderFilterInput @doc(category: "Orders") {
+input OrderFilterInput {
paymentStatus: [PaymentChargeStatusEnum!]
status: [OrderStatusFilter!]
customer: String
@@ -13400,7 +15158,7 @@ input OrderFilterInput @doc(category: "Orders") {
checkoutIds: [ID!]
}
-enum OrderStatusFilter @doc(category: "Orders") {
+enum OrderStatusFilter {
READY_TO_FULFILL
READY_TO_CAPTURE
UNFULFILLED
@@ -13410,7 +15168,7 @@ enum OrderStatusFilter @doc(category: "Orders") {
CANCELED
}
-input OrderWhereInput @doc(category: "Orders") {
+input OrderWhereInput {
"""Filter by metadata fields."""
metadata: MetadataFilterInput
ids: [ID!]
@@ -13531,7 +15289,7 @@ input IntFilterInput {
}
"""Filter by authorize status."""
-input OrderAuthorizeStatusEnumFilterInput @doc(category: "Orders") {
+input OrderAuthorizeStatusEnumFilterInput {
"""The value equal to."""
eq: OrderAuthorizeStatusEnum
@@ -13540,7 +15298,7 @@ input OrderAuthorizeStatusEnumFilterInput @doc(category: "Orders") {
}
"""Filter by charge status."""
-input OrderChargeStatusEnumFilterInput @doc(category: "Orders") {
+input OrderChargeStatusEnumFilterInput {
"""The value equal to."""
eq: OrderChargeStatusEnum
@@ -13549,7 +15307,7 @@ input OrderChargeStatusEnumFilterInput @doc(category: "Orders") {
}
"""Filter by order status."""
-input OrderStatusEnumFilterInput @doc(category: "Orders") {
+input OrderStatusEnumFilterInput {
"""The value equal to."""
eq: OrderStatus
@@ -13567,13 +15325,13 @@ input UUIDFilterInput {
}
"""Filter input for invoices."""
-input InvoiceFilterInput @doc(category: "Orders") {
+input InvoiceFilterInput {
"""Filter invoices by creation date."""
createdAt: DateTimeRangeInput
}
"""Filter input for order fulfillments data."""
-input FulfillmentFilterInput @doc(category: "Orders") {
+input FulfillmentFilterInput {
"""Filter by fulfillment status."""
status: FulfillmentStatusEnumFilterInput
@@ -13585,7 +15343,7 @@ input FulfillmentFilterInput @doc(category: "Orders") {
}
"""Filter by fulfillment status."""
-input FulfillmentStatusEnumFilterInput @doc(category: "Orders") {
+input FulfillmentStatusEnumFilterInput {
"""The value equal to."""
eq: FulfillmentStatus
@@ -13594,7 +15352,7 @@ input FulfillmentStatusEnumFilterInput @doc(category: "Orders") {
}
"""Filter input for fulfillment warehouses."""
-input FulfillmentWarehouseFilterInput @doc(category: "Orders") {
+input FulfillmentWarehouseFilterInput {
"""Filter fulfillments by warehouse ID."""
id: GlobalIDFilterInput
@@ -13606,16 +15364,23 @@ input FulfillmentWarehouseFilterInput @doc(category: "Orders") {
}
"""Filter input for order lines data."""
-input LinesFilterInput @doc(category: "Orders") {
+input LinesFilterInput {
"""Filter by metadata fields of order lines."""
metadata: MetadataFilterInput
}
"""Filter input for transactions."""
-input TransactionFilterInput @doc(category: "Orders") {
+input TransactionFilterInput {
"""Filter by payment method details used to pay for the order."""
paymentMethodDetails: PaymentMethodDetailsFilterInput
+ """
+ Filter by PSP reference of transactions.
+
+ Added in Saleor 3.22.
+ """
+ pspReference: StringFilterInput
+
"""Filter by metadata fields of transactions."""
metadata: MetadataFilterInput
}
@@ -13638,14 +15403,8 @@ input PaymentMethodTypeEnumFilterInput {
oneOf: [PaymentMethodTypeEnum!]
}
-"""
-Represents possible payment method types.
-
- The following types are possible:
- CARD - represents a card payment method.
- OTHER - represents any payment method that is not a card payment.
-"""
-enum PaymentMethodTypeEnum @doc(category: "Payments") {
+"Represents possible payment method types.\n\n The following types are possible:\n CARD - represents a card payment method.\n OTHER - represents any payment method that is not a card payment.\n\n "
+enum PaymentMethodTypeEnum {
CARD
OTHER
}
@@ -13664,7 +15423,7 @@ input PriceFilterInput {
}
"""Filter input for order events data."""
-input OrderEventFilterInput @doc(category: "Orders") {
+input OrderEventFilterInput {
"""Filter order events by date."""
date: DateTimeRangeInput
@@ -13681,13 +15440,13 @@ input OrderEventTypeEnumFilterInput {
}
"""Filtering options for addresses."""
-input AddressFilterInput @doc(category: "Users") {
+input AddressFilterInput {
phoneNumber: StringFilterInput
country: CountryCodeEnumFilterInput
}
"""Filter by country code."""
-input CountryCodeEnumFilterInput @doc(category: "Users") {
+input CountryCodeEnumFilterInput {
"""The value equal to."""
eq: CountryCode
@@ -13698,7 +15457,7 @@ input CountryCodeEnumFilterInput @doc(category: "Users") {
notOneOf: [CountryCode!]
}
-input OrderDraftFilterInput @doc(category: "Orders") {
+input OrderDraftFilterInput {
customer: String
created: DateRangeInput
search: String
@@ -13706,7 +15465,7 @@ input OrderDraftFilterInput @doc(category: "Orders") {
channels: [ID!]
}
-input DraftOrderWhereInput @doc(category: "Orders") {
+input DraftOrderWhereInput {
"""Filter by metadata fields."""
metadata: MetadataFilterInput
ids: [ID!]
@@ -13783,7 +15542,7 @@ input DraftOrderWhereInput @doc(category: "Orders") {
OR: [DraftOrderWhereInput!]
}
-type MenuCountableConnection @doc(category: "Menu") {
+type MenuCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [MenuCountableEdge!]!
@@ -13792,7 +15551,7 @@ type MenuCountableConnection @doc(category: "Menu") {
totalCount: Int
}
-type MenuCountableEdge @doc(category: "Menu") {
+type MenuCountableEdge {
"""The item at the end of the edge."""
node: Menu!
@@ -13823,7 +15582,7 @@ input MenuFilterInput {
slugs: [String!]
}
-type MenuItemCountableConnection @doc(category: "Menu") {
+type MenuItemCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [MenuItemCountableEdge!]!
@@ -13832,7 +15591,7 @@ type MenuItemCountableConnection @doc(category: "Menu") {
totalCount: Int
}
-type MenuItemCountableEdge @doc(category: "Menu") {
+type MenuItemCountableEdge {
"""The item at the end of the edge."""
node: MenuItem!
@@ -13858,7 +15617,7 @@ input MenuItemFilterInput {
metadata: [MetadataFilter!]
}
-input GiftCardSortingInput @doc(category: "Gift cards") {
+input GiftCardSortingInput {
"""Specifies the direction in which to sort gift cards."""
direction: OrderDirection!
@@ -13866,7 +15625,7 @@ input GiftCardSortingInput @doc(category: "Gift cards") {
field: GiftCardSortField!
}
-enum GiftCardSortField @doc(category: "Gift cards") {
+enum GiftCardSortField {
"""Sort gift cards by product."""
PRODUCT
@@ -13880,7 +15639,7 @@ enum GiftCardSortField @doc(category: "Gift cards") {
CREATED_AT
}
-input GiftCardFilterInput @doc(category: "Gift cards") {
+input GiftCardFilterInput {
isActive: Boolean
metadata: [MetadataFilter!]
tags: [String!]
@@ -13894,7 +15653,7 @@ input GiftCardFilterInput @doc(category: "Gift cards") {
createdByEmail: String
}
-type GiftCardTagCountableConnection @doc(category: "Gift cards") {
+type GiftCardTagCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [GiftCardTagCountableEdge!]!
@@ -13903,7 +15662,7 @@ type GiftCardTagCountableConnection @doc(category: "Gift cards") {
totalCount: Int
}
-type GiftCardTagCountableEdge @doc(category: "Gift cards") {
+type GiftCardTagCountableEdge {
"""The item at the end of the edge."""
node: GiftCardTag!
@@ -13911,7 +15670,7 @@ type GiftCardTagCountableEdge @doc(category: "Gift cards") {
cursor: String!
}
-input GiftCardTagFilterInput @doc(category: "Gift cards") {
+input GiftCardTagFilterInput {
search: String
}
@@ -14019,7 +15778,7 @@ enum PluginSortField {
IS_ACTIVE
}
-type SaleCountableConnection @doc(category: "Discounts") {
+type SaleCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [SaleCountableEdge!]!
@@ -14028,7 +15787,7 @@ type SaleCountableConnection @doc(category: "Discounts") {
totalCount: Int
}
-type SaleCountableEdge @doc(category: "Discounts") {
+type SaleCountableEdge {
"""The item at the end of the edge."""
node: Sale!
@@ -14036,7 +15795,7 @@ type SaleCountableEdge @doc(category: "Discounts") {
cursor: String!
}
-input SaleFilterInput @doc(category: "Discounts") {
+input SaleFilterInput {
status: [DiscountStatusEnum!]
saleType: DiscountValueTypeEnum
started: DateTimeRangeInput
@@ -14045,24 +15804,28 @@ input SaleFilterInput @doc(category: "Discounts") {
updatedAt: DateTimeRangeInput
}
-enum DiscountStatusEnum @doc(category: "Discounts") {
+enum DiscountStatusEnum {
ACTIVE
EXPIRED
SCHEDULED
}
-input SaleSortingInput @doc(category: "Discounts") {
+input SaleSortingInput {
"""Specifies the direction in which to sort sales."""
direction: OrderDirection!
- """Specifies the channel in which to sort the data."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
+ """
+ Specifies the channel in which to sort the data.
+
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ """
+ channel: String
"""Sort sales by the selected field."""
field: SaleSortField!
}
-enum SaleSortField @doc(category: "Discounts") {
+enum SaleSortField {
"""Sort sales by name."""
NAME
@@ -14089,7 +15852,7 @@ enum SaleSortField @doc(category: "Discounts") {
LAST_MODIFIED_AT
}
-type VoucherCountableConnection @doc(category: "Discounts") {
+type VoucherCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [VoucherCountableEdge!]!
@@ -14098,7 +15861,7 @@ type VoucherCountableConnection @doc(category: "Discounts") {
totalCount: Int
}
-type VoucherCountableEdge @doc(category: "Discounts") {
+type VoucherCountableEdge {
"""The item at the end of the edge."""
node: Voucher!
@@ -14106,7 +15869,7 @@ type VoucherCountableEdge @doc(category: "Discounts") {
cursor: String!
}
-input VoucherFilterInput @doc(category: "Discounts") {
+input VoucherFilterInput {
status: [DiscountStatusEnum!]
timesUsed: IntRangeInput
discountType: [VoucherDiscountType!]
@@ -14116,18 +15879,22 @@ input VoucherFilterInput @doc(category: "Discounts") {
ids: [ID!]
}
-enum VoucherDiscountType @doc(category: "Discounts") {
+enum VoucherDiscountType {
FIXED
PERCENTAGE
SHIPPING
}
-input VoucherSortingInput @doc(category: "Discounts") {
+input VoucherSortingInput {
"""Specifies the direction in which to sort vouchers."""
direction: OrderDirection!
- """Specifies the channel in which to sort the data."""
- channel: String @deprecated(reason: "Use root-level channel argument instead.")
+ """
+ Specifies the channel in which to sort the data.
+
+ DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ """
+ channel: String
"""Sort vouchers by the selected field."""
field: VoucherSortField!
@@ -14174,7 +15941,7 @@ enum VoucherSortField {
"""
Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers.
"""
-type Promotion implements Node & ObjectWithMetadata @doc(category: "Discounts") {
+type Promotion implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
@@ -14247,7 +16014,7 @@ type Promotion implements Node & ObjectWithMetadata @doc(category: "Discounts")
events: [PromotionEvent!]
}
-enum PromotionTypeEnum @doc(category: "Discounts") {
+enum PromotionTypeEnum {
CATALOGUE
ORDER
}
@@ -14255,7 +16022,7 @@ enum PromotionTypeEnum @doc(category: "Discounts") {
"""
Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount.
"""
-type PromotionRule implements Node @doc(category: "Discounts") {
+type PromotionRule implements Node {
id: ID!
"""Name of the promotion rule."""
@@ -14341,12 +16108,12 @@ type PromotionRule implements Node @doc(category: "Discounts") {
giftsLimit: Int
}
-enum RewardValueTypeEnum @doc(category: "Discounts") {
+enum RewardValueTypeEnum {
FIXED
PERCENTAGE
}
-enum RewardTypeEnum @doc(category: "Discounts") {
+enum RewardTypeEnum {
SUBTOTAL_DISCOUNT
GIFT
}
@@ -14354,7 +16121,7 @@ enum RewardTypeEnum @doc(category: "Discounts") {
union PromotionEvent = PromotionCreatedEvent | PromotionUpdatedEvent | PromotionStartedEvent | PromotionEndedEvent | PromotionRuleCreatedEvent | PromotionRuleUpdatedEvent | PromotionRuleDeletedEvent
"""History log of the promotion created event."""
-type PromotionCreatedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") {
+type PromotionCreatedEvent implements Node & PromotionEventInterface {
id: ID!
"""Date when event happened."""
@@ -14388,7 +16155,7 @@ interface PromotionEventInterface {
createdBy: UserOrApp
}
-enum PromotionEventsEnum @doc(category: "Discounts") {
+enum PromotionEventsEnum {
PROMOTION_CREATED
PROMOTION_UPDATED
PROMOTION_STARTED
@@ -14399,7 +16166,7 @@ enum PromotionEventsEnum @doc(category: "Discounts") {
}
"""History log of the promotion updated event."""
-type PromotionUpdatedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") {
+type PromotionUpdatedEvent implements Node & PromotionEventInterface {
id: ID!
"""Date when event happened."""
@@ -14417,7 +16184,7 @@ type PromotionUpdatedEvent implements Node & PromotionEventInterface @doc(catego
}
"""History log of the promotion started event."""
-type PromotionStartedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") {
+type PromotionStartedEvent implements Node & PromotionEventInterface {
id: ID!
"""Date when event happened."""
@@ -14435,7 +16202,7 @@ type PromotionStartedEvent implements Node & PromotionEventInterface @doc(catego
}
"""History log of the promotion ended event."""
-type PromotionEndedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") {
+type PromotionEndedEvent implements Node & PromotionEventInterface {
id: ID!
"""Date when event happened."""
@@ -14453,7 +16220,7 @@ type PromotionEndedEvent implements Node & PromotionEventInterface @doc(category
}
"""History log of the promotion rule created event."""
-type PromotionRuleCreatedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface @doc(category: "Discounts") {
+type PromotionRuleCreatedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface {
id: ID!
"""Date when event happened."""
@@ -14480,7 +16247,7 @@ interface PromotionRuleEventInterface {
}
"""History log of the promotion rule created event."""
-type PromotionRuleUpdatedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface @doc(category: "Discounts") {
+type PromotionRuleUpdatedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface {
id: ID!
"""Date when event happened."""
@@ -14501,7 +16268,7 @@ type PromotionRuleUpdatedEvent implements Node & PromotionEventInterface & Promo
}
"""History log of the promotion rule created event."""
-type PromotionRuleDeletedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface @doc(category: "Discounts") {
+type PromotionRuleDeletedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface {
id: ID!
"""Date when event happened."""
@@ -14521,7 +16288,7 @@ type PromotionRuleDeletedEvent implements Node & PromotionEventInterface & Promo
ruleId: String
}
-type PromotionCountableConnection @doc(category: "Discounts") {
+type PromotionCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [PromotionCountableEdge!]!
@@ -14530,7 +16297,7 @@ type PromotionCountableConnection @doc(category: "Discounts") {
totalCount: Int
}
-type PromotionCountableEdge @doc(category: "Discounts") {
+type PromotionCountableEdge {
"""The item at the end of the edge."""
node: Promotion!
@@ -14538,7 +16305,7 @@ type PromotionCountableEdge @doc(category: "Discounts") {
cursor: String!
}
-input PromotionWhereInput @doc(category: "Discounts") {
+input PromotionWhereInput {
metadata: [MetadataFilter!]
ids: [ID!]
@@ -14560,7 +16327,7 @@ input PromotionWhereInput @doc(category: "Discounts") {
OR: [PromotionWhereInput!]
}
-input PromotionTypeEnumFilterInput @doc(category: "Discounts") {
+input PromotionTypeEnumFilterInput {
"""The value equal to."""
eq: PromotionTypeEnum
@@ -14568,7 +16335,7 @@ input PromotionTypeEnumFilterInput @doc(category: "Discounts") {
oneOf: [PromotionTypeEnum!]
}
-input PromotionSortingInput @doc(category: "Discounts") {
+input PromotionSortingInput {
"""Specifies the direction in which to sort promotions."""
direction: OrderDirection!
@@ -14576,7 +16343,7 @@ input PromotionSortingInput @doc(category: "Discounts") {
field: PromotionSortField!
}
-enum PromotionSortField @doc(category: "Discounts") {
+enum PromotionSortField {
"""Sort promotions by name."""
NAME
@@ -14694,7 +16461,7 @@ enum ExportFileSortField {
LAST_MODIFIED_AT
}
-input CheckoutSortingInput @doc(category: "Checkout") {
+input CheckoutSortingInput {
"""Specifies the direction in which to sort checkouts."""
direction: OrderDirection!
@@ -14702,7 +16469,7 @@ input CheckoutSortingInput @doc(category: "Checkout") {
field: CheckoutSortField!
}
-enum CheckoutSortField @doc(category: "Checkout") {
+enum CheckoutSortField {
"""Sort checkouts by creation date."""
CREATION_DATE
@@ -14713,7 +16480,7 @@ enum CheckoutSortField @doc(category: "Checkout") {
PAYMENT
}
-input CheckoutFilterInput @doc(category: "Checkout") {
+input CheckoutFilterInput {
customer: String
created: DateRangeInput
search: String
@@ -14724,7 +16491,7 @@ input CheckoutFilterInput @doc(category: "Checkout") {
chargeStatus: [CheckoutChargeStatusEnum!]
}
-type CheckoutLineCountableConnection @doc(category: "Checkout") {
+type CheckoutLineCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [CheckoutLineCountableEdge!]!
@@ -14733,7 +16500,7 @@ type CheckoutLineCountableConnection @doc(category: "Checkout") {
totalCount: Int
}
-type CheckoutLineCountableEdge @doc(category: "Checkout") {
+type CheckoutLineCountableEdge {
"""The item at the end of the edge."""
node: CheckoutLine!
@@ -14741,7 +16508,7 @@ type CheckoutLineCountableEdge @doc(category: "Checkout") {
cursor: String!
}
-input AttributeSortingInput @doc(category: "Attributes") {
+input AttributeSortingInput {
"""Specifies the direction in which to sort attributes."""
direction: OrderDirection!
@@ -14749,7 +16516,7 @@ input AttributeSortingInput @doc(category: "Attributes") {
field: AttributeSortField!
}
-enum AttributeSortField @doc(category: "Attributes") {
+enum AttributeSortField {
"""Sort attributes by name"""
NAME
@@ -14781,7 +16548,7 @@ enum AttributeSortField @doc(category: "Attributes") {
}
"""Represents ongoing installation of app."""
-type AppInstallation implements Node & Job @doc(category: "Apps") {
+type AppInstallation implements Node & Job {
"""The ID of the app installation."""
id: ID!
@@ -14807,7 +16574,7 @@ type AppInstallation implements Node & Job @doc(category: "Apps") {
brand: AppBrand
}
-type AppCountableConnection @doc(category: "Apps") {
+type AppCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AppCountableEdge!]!
@@ -14816,7 +16583,7 @@ type AppCountableConnection @doc(category: "Apps") {
totalCount: Int
}
-type AppCountableEdge @doc(category: "Apps") {
+type AppCountableEdge {
"""The item at the end of the edge."""
node: App!
@@ -14824,13 +16591,13 @@ type AppCountableEdge @doc(category: "Apps") {
cursor: String!
}
-input AppFilterInput @doc(category: "Apps") {
+input AppFilterInput {
search: String
isActive: Boolean
type: AppTypeEnum
}
-input AppSortingInput @doc(category: "Apps") {
+input AppSortingInput {
"""Specifies the direction in which to sort apps."""
direction: OrderDirection!
@@ -14838,7 +16605,7 @@ input AppSortingInput @doc(category: "Apps") {
field: AppSortField!
}
-enum AppSortField @doc(category: "Apps") {
+enum AppSortField {
"""Sort apps by name."""
NAME
@@ -14846,7 +16613,7 @@ enum AppSortField @doc(category: "Apps") {
CREATION_DATE
}
-type AppExtensionCountableConnection @doc(category: "Apps") {
+type AppExtensionCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AppExtensionCountableEdge!]!
@@ -14855,7 +16622,7 @@ type AppExtensionCountableConnection @doc(category: "Apps") {
totalCount: Int
}
-type AppExtensionCountableEdge @doc(category: "Apps") {
+type AppExtensionCountableEdge {
"""The item at the end of the edge."""
node: AppExtension!
@@ -14863,12 +16630,20 @@ type AppExtensionCountableEdge @doc(category: "Apps") {
cursor: String!
}
-input AppExtensionFilterInput @doc(category: "Apps") {
- """DEPRECATED: Use `mountName` instead."""
- mount: [AppExtensionMountEnum!] @deprecated
+input AppExtensionFilterInput {
+ """
+ DEPRECATED: Use `mountName` instead.
+
+ DEPRECATED: this field will be removed.
+ """
+ mount: [AppExtensionMountEnum!]
- """DEPRECATED: Use `targetName` instead."""
- target: AppExtensionTargetEnum @deprecated
+ """
+ DEPRECATED: Use `targetName` instead.
+
+ DEPRECATED: this field will be removed.
+ """
+ target: AppExtensionTargetEnum
"""
Plain-text mount name (case insensitive)
@@ -14886,7 +16661,7 @@ input AppExtensionFilterInput @doc(category: "Apps") {
}
"""Represents address validation rules for a country."""
-type AddressValidationData @doc(category: "Users") {
+type AddressValidationData {
"""The country code of the address validation rule."""
countryCode: String!
@@ -14983,7 +16758,7 @@ type ChoiceValue {
verbose: String
}
-type UserCountableConnection @doc(category: "Users") {
+type UserCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [UserCountableEdge!]!
@@ -14992,7 +16767,7 @@ type UserCountableConnection @doc(category: "Users") {
totalCount: Int
}
-type UserCountableEdge @doc(category: "Users") {
+type UserCountableEdge {
"""The item at the end of the edge."""
node: User!
@@ -15000,7 +16775,7 @@ type UserCountableEdge @doc(category: "Users") {
cursor: String!
}
-input CustomerFilterInput @doc(category: "Users") {
+input CustomerFilterInput {
dateJoined: DateRangeInput
numberOfOrders: IntRangeInput
placedOrders: DateRangeInput
@@ -15012,7 +16787,7 @@ input CustomerFilterInput @doc(category: "Users") {
updatedAt: DateTimeRangeInput
}
-input CustomerWhereInput @doc(category: "Users") {
+input CustomerWhereInput {
"""Filter by metadata fields."""
metadata: MetadataFilterInput
ids: [ID!]
@@ -15051,7 +16826,7 @@ input CustomerWhereInput @doc(category: "Users") {
OR: [CustomerWhereInput!]
}
-input UserSortingInput @doc(category: "Users") {
+input UserSortingInput {
"""Specifies the direction in which to sort users."""
direction: OrderDirection!
@@ -15059,7 +16834,7 @@ input UserSortingInput @doc(category: "Users") {
field: UserSortField!
}
-enum UserSortField @doc(category: "Users") {
+enum UserSortField {
"""Sort users by first name."""
FIRST_NAME
@@ -15079,7 +16854,7 @@ enum UserSortField @doc(category: "Users") {
LAST_MODIFIED_AT
}
-type GroupCountableConnection @doc(category: "Users") {
+type GroupCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [GroupCountableEdge!]!
@@ -15088,7 +16863,7 @@ type GroupCountableConnection @doc(category: "Users") {
totalCount: Int
}
-type GroupCountableEdge @doc(category: "Users") {
+type GroupCountableEdge {
"""The item at the end of the edge."""
node: Group!
@@ -15096,12 +16871,12 @@ type GroupCountableEdge @doc(category: "Users") {
cursor: String!
}
-input PermissionGroupFilterInput @doc(category: "Users") {
+input PermissionGroupFilterInput {
search: String
ids: [ID!]
}
-input PermissionGroupSortingInput @doc(category: "Users") {
+input PermissionGroupSortingInput {
"""Specifies the direction in which to sort permission group."""
direction: OrderDirection!
@@ -15110,19 +16885,19 @@ input PermissionGroupSortingInput @doc(category: "Users") {
}
"""Sorting options for permission groups."""
-enum PermissionGroupSortField @doc(category: "Users") {
+enum PermissionGroupSortField {
"""Sort permission group accounts by name."""
NAME
}
-input StaffUserInput @doc(category: "Users") {
+input StaffUserInput {
status: StaffMemberStatus
search: String
ids: [ID!]
}
"""Represents status of a staff account."""
-enum StaffMemberStatus @doc(category: "Users") {
+enum StaffMemberStatus {
"""User account has been activated."""
ACTIVE
@@ -15139,7 +16914,7 @@ type Mutation {
webhookCreate(
"""Fields required to create a webhook."""
input: WebhookCreateInput!
- ): WebhookCreate @doc(category: "Webhooks")
+ ): WebhookCreate
"""
Deletes 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.
@@ -15149,7 +16924,7 @@ type Mutation {
webhookDelete(
"""ID of a webhook to delete."""
id: ID!
- ): WebhookDelete @doc(category: "Webhooks")
+ ): WebhookDelete
"""
Updates a webhook subscription.
@@ -15162,7 +16937,7 @@ type Mutation {
"""Fields required to update a webhook."""
input: WebhookUpdateInput!
- ): WebhookUpdate @doc(category: "Webhooks")
+ ): WebhookUpdate
"""
Retries event delivery.
@@ -15172,7 +16947,7 @@ type Mutation {
eventDeliveryRetry(
"""ID of the event delivery to retry."""
id: ID!
- ): EventDeliveryRetry @doc(category: "Webhooks")
+ ): EventDeliveryRetry
"""
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.
@@ -15185,7 +16960,7 @@ type Mutation {
"""The subscription query that defines the webhook event and its payload."""
query: String!
- ): WebhookDryRun @doc(category: "Webhooks")
+ ): WebhookDryRun
"""
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.
@@ -15198,7 +16973,7 @@ type Mutation {
"""The ID of the webhook."""
webhookId: ID!
- ): WebhookTrigger @doc(category: "Webhooks")
+ ): WebhookTrigger
"""
Creates a new warehouse.
@@ -15208,7 +16983,7 @@ type Mutation {
createWarehouse(
"""Fields required to create warehouse."""
input: WarehouseCreateInput!
- ): WarehouseCreate @doc(category: "Products")
+ ): WarehouseCreate
"""
Updates given warehouse.
@@ -15224,7 +16999,7 @@ type Mutation {
"""Fields required to update warehouse."""
input: WarehouseUpdateInput!
- ): WarehouseUpdate @doc(category: "Products")
+ ): WarehouseUpdate
"""
Deletes selected warehouse.
@@ -15234,7 +17009,7 @@ type Mutation {
deleteWarehouse(
"""ID of a warehouse to delete."""
id: ID!
- ): WarehouseDelete @doc(category: "Products")
+ ): WarehouseDelete
"""
Add shipping zone to given warehouse.
@@ -15247,7 +17022,7 @@ type Mutation {
"""List of shipping zone IDs."""
shippingZoneIds: [ID!]!
- ): WarehouseShippingZoneAssign @doc(category: "Products")
+ ): WarehouseShippingZoneAssign
"""
Remove shipping zone from given warehouse.
@@ -15260,7 +17035,7 @@ type Mutation {
"""List of shipping zone IDs."""
shippingZoneIds: [ID!]!
- ): WarehouseShippingZoneUnassign @doc(category: "Products")
+ ): WarehouseShippingZoneUnassign
"""
Creates a tax class.
@@ -15270,7 +17045,7 @@ type Mutation {
taxClassCreate(
"""Fields required to create a tax class."""
input: TaxClassCreateInput!
- ): TaxClassCreate @doc(category: "Taxes")
+ ): TaxClassCreate
"""
Deletes 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.
@@ -15280,7 +17055,7 @@ type Mutation {
taxClassDelete(
"""ID of a tax class to delete."""
id: ID!
- ): TaxClassDelete @doc(category: "Taxes")
+ ): TaxClassDelete
"""
Updates a tax class.
@@ -15293,7 +17068,7 @@ type Mutation {
"""Fields required to update a tax class."""
input: TaxClassUpdateInput!
- ): TaxClassUpdate @doc(category: "Taxes")
+ ): TaxClassUpdate
"""
Updates tax configuration for a channel.
@@ -15306,7 +17081,7 @@ type Mutation {
"""Fields required to update the tax configuration."""
input: TaxConfigurationUpdateInput!
- ): TaxConfigurationUpdate @doc(category: "Taxes")
+ ): TaxConfigurationUpdate
"""
Updates tax class rates for a specific country.
@@ -15321,7 +17096,7 @@ type Mutation {
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")
+ ): TaxCountryConfigurationUpdate
"""
Remove all tax class rates for a specific country.
@@ -15331,7 +17106,7 @@ type Mutation {
taxCountryConfigurationDelete(
"""Country in which to update the tax class rates."""
countryCode: CountryCode!
- ): TaxCountryConfigurationDelete @doc(category: "Taxes")
+ ): TaxCountryConfigurationDelete
"""
Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known.
@@ -15344,7 +17119,7 @@ type Mutation {
"""Determines if a taxes should be exempt."""
taxExemption: Boolean!
- ): TaxExemptionManage @doc(category: "Taxes")
+ ): TaxExemptionManage
"""
Updates stocks for a given variant and warehouse. Variant and warehouse selectors have to be the same for all stock inputs. Is not allowed to use 'variantId' in one input and 'variantExternalReference' in another.
@@ -15360,7 +17135,7 @@ type Mutation {
"""Input list of stocks to update."""
stocks: [StockBulkUpdateInput!]!
- ): StockBulkUpdate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [PRODUCT_VARIANT_STOCK_UPDATED], syncEvents: [])
+ ): StockBulkUpdate
"""
Creates a new staff notification recipient.
@@ -15370,7 +17145,7 @@ type Mutation {
staffNotificationRecipientCreate(
"""Fields required to create a staff notification recipient."""
input: StaffNotificationRecipientInput!
- ): StaffNotificationRecipientCreate @doc(category: "Users")
+ ): StaffNotificationRecipientCreate
"""
Updates a staff notification recipient.
@@ -15383,7 +17158,7 @@ type Mutation {
"""Fields required to update a staff notification recipient."""
input: StaffNotificationRecipientInput!
- ): StaffNotificationRecipientUpdate @doc(category: "Users")
+ ): StaffNotificationRecipientUpdate
"""
Deletes staff notification recipient.
@@ -15393,7 +17168,7 @@ type Mutation {
staffNotificationRecipientDelete(
"""ID of a staff notification recipient to delete."""
id: ID!
- ): StaffNotificationRecipientDelete @doc(category: "Users")
+ ): StaffNotificationRecipientDelete
"""
Updates site domain of the shop.
@@ -15403,7 +17178,7 @@ type Mutation {
shopDomainUpdate(
"""Fields required to update site."""
input: SiteDomainInput
- ): ShopDomainUpdate @doc(category: "Shop") @deprecated(reason: "Use `PUBLIC_URL` environment variable instead.")
+ ): ShopDomainUpdate @deprecated(reason: "Use `PUBLIC_URL` environment variable instead.")
"""
Updates shop settings.
@@ -15416,14 +17191,14 @@ type Mutation {
shopSettingsUpdate(
"""Fields required to update shop settings."""
input: ShopSettingsInput!
- ): ShopSettingsUpdate @doc(category: "Shop") @webhookEventsInfo(asyncEvents: [SHOP_METADATA_UPDATED], syncEvents: [])
+ ): ShopSettingsUpdate
"""
Fetch tax rates.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
- shopFetchTaxRates: ShopFetchTaxRates @doc(category: "Shop") @deprecated
+ shopFetchTaxRates: ShopFetchTaxRates @deprecated
"""
Creates/updates translations for shop settings.
@@ -15436,7 +17211,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): ShopSettingsTranslate @doc(category: "Shop")
+ ): ShopSettingsTranslate
"""
Update the shop's address. If the `null` value is passed, the currently selected address will be deleted.
@@ -15446,7 +17221,7 @@ type Mutation {
shopAddressUpdate(
"""Fields required to update shop address."""
input: AddressInput
- ): ShopAddressUpdate @doc(category: "Shop")
+ ): ShopAddressUpdate
"""
Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order.
@@ -15456,7 +17231,7 @@ type Mutation {
orderSettingsUpdate(
"""Fields required to update shop order settings."""
input: OrderSettingsUpdateInput!
- ): OrderSettingsUpdate @doc(category: "Orders") @deprecated(reason: "Use `channelUpdate` mutation instead.")
+ ): OrderSettingsUpdate @deprecated(reason: "Use `channelUpdate` mutation instead.")
"""
Update gift card settings.
@@ -15466,7 +17241,7 @@ type Mutation {
giftCardSettingsUpdate(
"""Fields required to update gift card settings."""
input: GiftCardSettingsUpdateInput!
- ): GiftCardSettingsUpdate @doc(category: "Gift cards")
+ ): GiftCardSettingsUpdate
"""
Update refund settings across all channels.
@@ -15478,7 +17253,7 @@ type Mutation {
refundSettingsUpdate(
"""Fields required to update refund settings."""
input: RefundSettingsUpdateInput!
- ): RefundSettingsUpdate @doc(category: "Shop")
+ ): RefundSettingsUpdate
"""
Updates RefundSettings. The `Page` (Model) Type will be cleared from `reasonReferenceType`. When it's cleared, passing reason reference to refund mutations is no longer accepted and will raise error.
@@ -15487,7 +17262,28 @@ type Mutation {
Requires one of the following permissions: MANAGE_SETTINGS.
"""
- refundReasonReferenceClear: RefundReasonReferenceTypeClear @doc(category: "Orders")
+ refundReasonReferenceClear: RefundReasonReferenceTypeClear
+
+ """
+ Update return settings across all channels.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ returnSettingsUpdate(
+ """Fields required to update return settings."""
+ input: ReturnSettingsUpdateInput!
+ ): ReturnSettingsUpdate
+
+ """
+ Updates ReturnSettings. The `Page` (Model) Type will be cleared from `reasonReferenceType`. When it's cleared, passing reason reference to return mutations is no longer accepted and will raise error.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: MANAGE_SETTINGS.
+ """
+ returnReasonReferenceClear: ReturnReasonReferenceTypeClear
"""
Manage shipping method's availability in channels.
@@ -15500,7 +17296,7 @@ type Mutation {
"""Fields required to update shipping method channel listings."""
input: ShippingMethodChannelListingInput!
- ): ShippingMethodChannelListingUpdate @doc(category: "Shipping")
+ ): ShippingMethodChannelListingUpdate
"""
Creates a new shipping price.
@@ -15510,7 +17306,7 @@ type Mutation {
shippingPriceCreate(
"""Fields required to create a shipping price."""
input: ShippingPriceInput!
- ): ShippingPriceCreate @doc(category: "Shipping")
+ ): ShippingPriceCreate
"""
Deletes a shipping price.
@@ -15520,7 +17316,7 @@ type Mutation {
shippingPriceDelete(
"""ID of a shipping price to delete."""
id: ID!
- ): ShippingPriceDelete @doc(category: "Shipping")
+ ): ShippingPriceDelete
"""
Deletes shipping prices.
@@ -15530,7 +17326,7 @@ type Mutation {
shippingPriceBulkDelete(
"""List of shipping price IDs to delete."""
ids: [ID!]!
- ): ShippingPriceBulkDelete @doc(category: "Shipping")
+ ): ShippingPriceBulkDelete
"""
Updates a new shipping price.
@@ -15543,7 +17339,7 @@ type Mutation {
"""Fields required to update a shipping price."""
input: ShippingPriceInput!
- ): ShippingPriceUpdate @doc(category: "Shipping")
+ ): ShippingPriceUpdate
"""
Creates/updates translations for a shipping method.
@@ -15559,7 +17355,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): ShippingPriceTranslate @doc(category: "Shipping")
+ ): ShippingPriceTranslate
"""
Exclude products from shipping price.
@@ -15572,7 +17368,7 @@ type Mutation {
"""Exclude products input."""
input: ShippingPriceExcludeProductsInput!
- ): ShippingPriceExcludeProducts @doc(category: "Shipping")
+ ): ShippingPriceExcludeProducts
"""
Remove product from excluded list for shipping price.
@@ -15585,7 +17381,7 @@ type Mutation {
"""List of products which will be removed from excluded list."""
products: [ID!]!
- ): ShippingPriceRemoveProductFromExclude @doc(category: "Shipping")
+ ): ShippingPriceRemoveProductFromExclude
"""
Creates a new shipping zone.
@@ -15595,7 +17391,7 @@ type Mutation {
shippingZoneCreate(
"""Fields required to create a shipping zone."""
input: ShippingZoneCreateInput!
- ): ShippingZoneCreate @doc(category: "Shipping")
+ ): ShippingZoneCreate
"""
Deletes a shipping zone.
@@ -15605,7 +17401,7 @@ type Mutation {
shippingZoneDelete(
"""ID of a shipping zone to delete."""
id: ID!
- ): ShippingZoneDelete @doc(category: "Shipping")
+ ): ShippingZoneDelete
"""
Deletes shipping zones.
@@ -15615,7 +17411,7 @@ type Mutation {
shippingZoneBulkDelete(
"""List of shipping zone IDs to delete."""
ids: [ID!]!
- ): ShippingZoneBulkDelete @doc(category: "Shipping")
+ ): ShippingZoneBulkDelete
"""
Updates a new shipping zone.
@@ -15628,7 +17424,7 @@ type Mutation {
"""Fields required to update a shipping zone."""
input: ShippingZoneUpdateInput!
- ): ShippingZoneUpdate @doc(category: "Shipping")
+ ): ShippingZoneUpdate
"""
Assign attributes to a given product type.
@@ -15641,7 +17437,7 @@ type Mutation {
"""ID of the product type to assign the attributes into."""
productTypeId: ID!
- ): ProductAttributeAssign @doc(category: "Products")
+ ): ProductAttributeAssign
"""
Update attributes assigned to product variant for given product type.
@@ -15654,7 +17450,7 @@ type Mutation {
"""ID of the product type to assign the attributes into."""
productTypeId: ID!
- ): ProductAttributeAssignmentUpdate @doc(category: "Products")
+ ): ProductAttributeAssignmentUpdate
"""
Un-assign attributes from a given product type.
@@ -15667,7 +17463,7 @@ type Mutation {
"""ID of the product type from which the attributes should be unassigned."""
productTypeId: ID!
- ): ProductAttributeUnassign @doc(category: "Products")
+ ): ProductAttributeUnassign
"""
Creates a new category.
@@ -15682,7 +17478,7 @@ type Mutation {
ID of the parent category. If empty, category will be top level category.
"""
parent: ID
- ): CategoryCreate @doc(category: "Products")
+ ): CategoryCreate
"""
Deletes a category.
@@ -15692,7 +17488,7 @@ type Mutation {
categoryDelete(
"""ID of a category to delete."""
id: ID!
- ): CategoryDelete @doc(category: "Products")
+ ): CategoryDelete
"""
Deletes categories.
@@ -15702,7 +17498,7 @@ type Mutation {
categoryBulkDelete(
"""List of category IDs to delete."""
ids: [ID!]!
- ): CategoryBulkDelete @doc(category: "Products")
+ ): CategoryBulkDelete
"""
Updates a category.
@@ -15715,7 +17511,7 @@ type Mutation {
"""Fields required to update a category."""
input: CategoryInput!
- ): CategoryUpdate @doc(category: "Products")
+ ): CategoryUpdate
"""
Creates/updates translations for a category.
@@ -15731,7 +17527,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): CategoryTranslate @doc(category: "Products")
+ ): CategoryTranslate
"""
Adds products to a collection.
@@ -15744,7 +17540,7 @@ type Mutation {
"""List of product IDs."""
products: [ID!]!
- ): CollectionAddProducts @doc(category: "Products")
+ ): CollectionAddProducts
"""
Creates a new collection.
@@ -15754,7 +17550,7 @@ type Mutation {
collectionCreate(
"""Fields required to create a collection."""
input: CollectionCreateInput!
- ): CollectionCreate @doc(category: "Products")
+ ): CollectionCreate
"""
Deletes a collection.
@@ -15764,7 +17560,7 @@ type Mutation {
collectionDelete(
"""ID of a collection to delete."""
id: ID!
- ): CollectionDelete @doc(category: "Products")
+ ): CollectionDelete
"""
Reorder the products of a collection.
@@ -15777,7 +17573,7 @@ type Mutation {
"""The collection products position operations."""
moves: [MoveProductInput!]!
- ): CollectionReorderProducts @doc(category: "Products")
+ ): CollectionReorderProducts
"""
Deletes collections.
@@ -15787,7 +17583,7 @@ type Mutation {
collectionBulkDelete(
"""List of collection IDs to delete."""
ids: [ID!]!
- ): CollectionBulkDelete @doc(category: "Products")
+ ): CollectionBulkDelete
"""
Remove products from a collection.
@@ -15800,7 +17596,7 @@ type Mutation {
"""List of product IDs."""
products: [ID!]!
- ): CollectionRemoveProducts @doc(category: "Products")
+ ): CollectionRemoveProducts
"""
Updates a collection.
@@ -15813,7 +17609,7 @@ type Mutation {
"""Fields required to update a collection."""
input: CollectionInput!
- ): CollectionUpdate @doc(category: "Products")
+ ): CollectionUpdate
"""
Creates/updates translations for a collection.
@@ -15829,7 +17625,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): CollectionTranslate @doc(category: "Products")
+ ): CollectionTranslate
"""
Manage collection's availability in channels.
@@ -15842,7 +17638,7 @@ type Mutation {
"""Fields required to create or update collection channel listings."""
input: CollectionChannelListingUpdateInput!
- ): CollectionChannelListingUpdate @doc(category: "Products")
+ ): CollectionChannelListingUpdate
"""
Creates a new product.
@@ -15852,7 +17648,7 @@ type Mutation {
productCreate(
"""Fields required to create a product."""
input: ProductCreateInput!
- ): ProductCreate @doc(category: "Products")
+ ): ProductCreate
"""
Deletes a product.
@@ -15865,7 +17661,7 @@ type Mutation {
"""ID of a product to delete."""
id: ID
- ): ProductDelete @doc(category: "Products")
+ ): ProductDelete
"""
Creates products.
@@ -15878,7 +17674,7 @@ type Mutation {
"""Input list of products to create."""
products: [ProductBulkCreateInput!]!
- ): ProductBulkCreate @doc(category: "Products")
+ ): ProductBulkCreate
"""
Deletes products.
@@ -15888,7 +17684,7 @@ type Mutation {
productBulkDelete(
"""List of product IDs to delete."""
ids: [ID!]!
- ): ProductBulkDelete @doc(category: "Products")
+ ): ProductBulkDelete
"""
Updates an existing product.
@@ -15904,7 +17700,7 @@ type Mutation {
"""Fields required to update a product."""
input: ProductInput!
- ): ProductUpdate @doc(category: "Products")
+ ): ProductUpdate
"""
Creates/updates translations for products.
@@ -15921,7 +17717,7 @@ type Mutation {
"""List of product translations."""
translations: [ProductBulkTranslateInput!]!
- ): ProductBulkTranslate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [TRANSLATION_CREATED, TRANSLATION_UPDATED], syncEvents: [])
+ ): ProductBulkTranslate
"""
Creates/updates translations for a product.
@@ -15937,7 +17733,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): ProductTranslate @doc(category: "Products")
+ ): ProductTranslate
"""
Manage product's availability in channels.
@@ -15950,7 +17746,7 @@ type Mutation {
"""Fields required to create or update product channel listings."""
input: ProductChannelListingUpdateInput!
- ): ProductChannelListingUpdate @doc(category: "Products")
+ ): ProductChannelListingUpdate
"""
Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
@@ -15960,7 +17756,7 @@ type Mutation {
productMediaCreate(
"""Fields required to create a product media."""
input: ProductMediaCreateInput!
- ): ProductMediaCreate @doc(category: "Products")
+ ): ProductMediaCreate
"""
Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.
@@ -15973,7 +17769,7 @@ type Mutation {
"""Id of product that variants order will be altered."""
productId: ID!
- ): ProductVariantReorder @doc(category: "Products")
+ ): ProductVariantReorder
"""
Deletes a product media.
@@ -15983,7 +17779,7 @@ type Mutation {
productMediaDelete(
"""ID of a product media to delete."""
id: ID!
- ): ProductMediaDelete @doc(category: "Products")
+ ): ProductMediaDelete
"""
Deletes product media.
@@ -15993,7 +17789,7 @@ type Mutation {
productMediaBulkDelete(
"""List of product media IDs to delete."""
ids: [ID!]!
- ): ProductMediaBulkDelete @doc(category: "Products")
+ ): ProductMediaBulkDelete
"""
Changes ordering of the product media.
@@ -16006,7 +17802,7 @@ type Mutation {
"""ID of product that media order will be altered."""
productId: ID!
- ): ProductMediaReorder @doc(category: "Products")
+ ): ProductMediaReorder
"""
Updates a product media.
@@ -16019,7 +17815,7 @@ type Mutation {
"""Fields required to update a product media."""
input: ProductMediaUpdateInput!
- ): ProductMediaUpdate @doc(category: "Products")
+ ): ProductMediaUpdate
"""
Creates a new product type.
@@ -16029,7 +17825,7 @@ type Mutation {
productTypeCreate(
"""Fields required to create a product type."""
input: ProductTypeInput!
- ): ProductTypeCreate @doc(category: "Products")
+ ): ProductTypeCreate
"""
Deletes a product type.
@@ -16039,7 +17835,7 @@ type Mutation {
productTypeDelete(
"""ID of a product type to delete."""
id: ID!
- ): ProductTypeDelete @doc(category: "Products")
+ ): ProductTypeDelete
"""
Deletes product types.
@@ -16049,7 +17845,7 @@ type Mutation {
productTypeBulkDelete(
"""List of product type IDs to delete."""
ids: [ID!]!
- ): ProductTypeBulkDelete @doc(category: "Products")
+ ): ProductTypeBulkDelete
"""
Updates an existing product type.
@@ -16062,7 +17858,7 @@ type Mutation {
"""Fields required to update a product type."""
input: ProductTypeInput!
- ): ProductTypeUpdate @doc(category: "Products")
+ ): ProductTypeUpdate
"""
Reorder the attributes of a product type.
@@ -16078,7 +17874,7 @@ type Mutation {
"""The attribute type to reorder."""
type: ProductAttributeType!
- ): ProductTypeReorderAttributes @doc(category: "Products")
+ ): ProductTypeReorderAttributes
"""
Reorder product attribute values.
@@ -16094,7 +17890,7 @@ type Mutation {
"""ID of a product."""
productId: ID!
- ): ProductReorderAttributeValues @doc(category: "Products")
+ ): ProductReorderAttributeValues
"""
Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
@@ -16107,7 +17903,7 @@ type Mutation {
"""ID of a product variant to upload digital content."""
variantId: ID!
- ): DigitalContentCreate @doc(category: "Products")
+ ): DigitalContentCreate @deprecated(reason: "Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.")
"""
Remove digital content assigned to given variant.
@@ -16117,7 +17913,7 @@ type Mutation {
digitalContentDelete(
"""ID of a product variant with digital content to remove."""
variantId: ID!
- ): DigitalContentDelete @doc(category: "Products")
+ ): DigitalContentDelete @deprecated(reason: "Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.")
"""
Updates digital content.
@@ -16130,7 +17926,7 @@ type Mutation {
"""ID of a product variant with digital content to update."""
variantId: ID!
- ): DigitalContentUpdate @doc(category: "Products")
+ ): DigitalContentUpdate @deprecated(reason: "Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.")
"""
Generate new URL to digital content.
@@ -16140,7 +17936,7 @@ type Mutation {
digitalContentUrlCreate(
"""Fields required to create a new url."""
input: DigitalContentUrlCreateInput!
- ): DigitalContentUrlCreate @doc(category: "Products")
+ ): DigitalContentUrlCreate @deprecated(reason: "Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.")
"""
Creates a new variant for a product.
@@ -16150,7 +17946,7 @@ type Mutation {
productVariantCreate(
"""Fields required to create a product variant."""
input: ProductVariantCreateInput!
- ): ProductVariantCreate @doc(category: "Products")
+ ): ProductVariantCreate
"""
Deletes a product variant.
@@ -16166,7 +17962,7 @@ type Mutation {
"""SKU of a product variant to delete."""
sku: String
- ): ProductVariantDelete @doc(category: "Products")
+ ): ProductVariantDelete
"""
Creates product variants for a given product.
@@ -16182,7 +17978,7 @@ type Mutation {
"""Input list of product variants to create."""
variants: [ProductVariantBulkCreateInput!]!
- ): ProductVariantBulkCreate @doc(category: "Products")
+ ): ProductVariantBulkCreate
"""
Updates multiple product variants.
@@ -16198,7 +17994,7 @@ type Mutation {
"""Input list of product variants to update."""
variants: [ProductVariantBulkUpdateInput!]!
- ): ProductVariantBulkUpdate @doc(category: "Products")
+ ): ProductVariantBulkUpdate
"""
Deletes product variants.
@@ -16211,7 +18007,7 @@ type Mutation {
"""List of product variant SKUs to delete."""
skus: [String!]
- ): ProductVariantBulkDelete @doc(category: "Products")
+ ): ProductVariantBulkDelete
"""
Creates stocks for product variant.
@@ -16224,7 +18020,7 @@ type Mutation {
"""ID of a product variant for which stocks will be created."""
variantId: ID!
- ): ProductVariantStocksCreate @doc(category: "Products")
+ ): ProductVariantStocksCreate
"""
Deletes stocks from product variant.
@@ -16240,7 +18036,7 @@ type Mutation {
"""Input list of warehouse IDs."""
warehouseIds: [ID!]
- ): ProductVariantStocksDelete @doc(category: "Products")
+ ): ProductVariantStocksDelete
"""
Updates stocks for product variant.
@@ -16256,7 +18052,7 @@ type Mutation {
"""ID of a product variant for which stocks will be updated."""
variantId: ID
- ): ProductVariantStocksUpdate @doc(category: "Products")
+ ): ProductVariantStocksUpdate
"""
Updates an existing variant for product.
@@ -16275,7 +18071,7 @@ type Mutation {
"""SKU of a product variant to update."""
sku: String
- ): ProductVariantUpdate @doc(category: "Products")
+ ): ProductVariantUpdate
"""
Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
@@ -16288,7 +18084,7 @@ type Mutation {
"""Id of a variant that will be set as default."""
variantId: ID!
- ): ProductVariantSetDefault @doc(category: "Products")
+ ): ProductVariantSetDefault
"""
Creates/updates translations for a product variant.
@@ -16304,7 +18100,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): ProductVariantTranslate @doc(category: "Products")
+ ): ProductVariantTranslate
"""
Creates/updates translations for product variants.
@@ -16321,7 +18117,7 @@ type Mutation {
"""List of product variant translations."""
translations: [ProductVariantBulkTranslateInput!]!
- ): ProductVariantBulkTranslate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [TRANSLATION_CREATED, TRANSLATION_UPDATED], syncEvents: [])
+ ): ProductVariantBulkTranslate
"""
Manage product variant prices in channels.
@@ -16339,7 +18135,7 @@ type Mutation {
"""SKU of a product variant to update."""
sku: String
- ): ProductVariantChannelListingUpdate @doc(category: "Products")
+ ): ProductVariantChannelListingUpdate
"""
Reorder product variant attribute values.
@@ -16355,7 +18151,7 @@ type Mutation {
"""ID of a product variant."""
variantId: ID!
- ): ProductVariantReorderAttributeValues @doc(category: "Products")
+ ): ProductVariantReorderAttributeValues
"""
Deactivates product variant preorder. It changes all preorder allocation into regular allocation.
@@ -16365,7 +18161,7 @@ type Mutation {
productVariantPreorderDeactivate(
"""ID of a variant which preorder should be deactivated."""
id: ID!
- ): ProductVariantPreorderDeactivate @doc(category: "Products")
+ ): ProductVariantPreorderDeactivate
"""
Assign an media to a product variant.
@@ -16378,7 +18174,7 @@ type Mutation {
"""ID of a product variant."""
variantId: ID!
- ): VariantMediaAssign @doc(category: "Products")
+ ): VariantMediaAssign
"""
Unassign an media from a product variant.
@@ -16391,7 +18187,7 @@ type Mutation {
"""ID of a product variant."""
variantId: ID!
- ): VariantMediaUnassign @doc(category: "Products")
+ ): VariantMediaUnassign
"""
Captures the authorized payment amount.
@@ -16404,7 +18200,7 @@ type Mutation {
"""Payment ID."""
paymentId: ID!
- ): PaymentCapture @doc(category: "Payments")
+ ): PaymentCapture
"""
Refunds the captured payment amount.
@@ -16417,7 +18213,7 @@ type Mutation {
"""Payment ID."""
paymentId: ID!
- ): PaymentRefund @doc(category: "Payments")
+ ): PaymentRefund
"""
Voids the authorized payment.
@@ -16427,7 +18223,7 @@ type Mutation {
paymentVoid(
"""Payment ID."""
paymentId: ID!
- ): PaymentVoid @doc(category: "Payments")
+ ): PaymentVoid
"""Initializes payment process when it is required by gateway."""
paymentInitialize(
@@ -16439,13 +18235,13 @@ type Mutation {
"""Client-side generated data required to initialize the payment."""
paymentData: JSONString
- ): PaymentInitialize @doc(category: "Payments")
+ ): PaymentInitialize
"""Check payment balance."""
paymentCheckBalance(
"""Fields required to check payment balance."""
input: PaymentCheckBalanceInput!
- ): PaymentCheckBalance @doc(category: "Payments")
+ ): PaymentCheckBalance
"""
Creates transaction for checkout or order.
@@ -16461,7 +18257,7 @@ type Mutation {
"""Data that defines a transaction event."""
transactionEvent: TransactionEventInput
- ): TransactionCreate @doc(category: "Payments")
+ ): TransactionCreate
"""
Update transaction.
@@ -16480,7 +18276,7 @@ type Mutation {
"""Data that defines a transaction transaction."""
transactionEvent: TransactionEventInput
- ): TransactionUpdate @doc(category: "Payments")
+ ): TransactionUpdate
"""
Request an action for payment transaction.
@@ -16515,7 +18311,7 @@ type Mutation {
"""The token of the transaction. One of field id or token is required."""
token: UUID
- ): TransactionRequestAction @doc(category: "Payments")
+ ): TransactionRequestAction
"""
Request a refund for payment transaction based on granted refund.
@@ -16535,7 +18331,7 @@ type Mutation {
The token of the transaction. One of field id or token is required, if `transactionItem` is not already assigned to the `orderGrantedRefund`. If `transactionItem` is already assigned to the grantedRefund the field will be ignored.
"""
token: UUID
- ): TransactionRequestRefundForGrantedRefund @doc(category: "Payments")
+ ): TransactionRequestRefundForGrantedRefund
"""
Report the event for the transaction.
@@ -16607,7 +18403,7 @@ type Mutation {
"""Current status of the event to report."""
type: TransactionEventTypeEnum!
- ): TransactionEventReport @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [TRANSACTION_ITEM_METADATA_UPDATED, CHECKOUT_FULLY_PAID, ORDER_UPDATED], syncEvents: [])
+ ): TransactionEventReport
"""
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. There is a limit of 100 transaction items per checkout / order.
@@ -16623,7 +18419,7 @@ type Mutation {
"""List of payment gateways to initialize."""
paymentGateways: [PaymentGatewayToInitialize!]
- ): PaymentGatewayInitialize @doc(category: "Payments")
+ ): PaymentGatewayInitialize
"""
Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. There is a limit of 100 transaction items per checkout / order.
@@ -16654,10 +18450,10 @@ type Mutation {
"""Payment gateway used to initialize the transaction."""
paymentGateway: PaymentGatewayToInitialize!
- ): TransactionInitialize @doc(category: "Payments")
+ ): TransactionInitialize
"""
- Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`.
+ Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`.
"""
transactionProcess(
"""
@@ -16677,7 +18473,7 @@ type Mutation {
The token of the transaction to process. One of field id or token is required.
"""
token: UUID
- ): TransactionProcess @doc(category: "Payments")
+ ): TransactionProcess
"""
Request to delete a stored payment method on payment provider side.
@@ -16693,7 +18489,7 @@ type Mutation {
"""The ID of the payment method."""
id: ID!
- ): StoredPaymentMethodRequestDelete @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [STORED_PAYMENT_METHOD_DELETE_REQUESTED])
+ ): StoredPaymentMethodRequestDelete
"""
Initializes payment gateway for tokenizing payment method session.
@@ -16712,7 +18508,7 @@ type Mutation {
"""The identifier of the payment gateway app to initialize tokenization."""
id: String!
- ): PaymentGatewayInitializeTokenization @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_GATEWAY_INITIALIZE_TOKENIZATION_SESSION])
+ ): PaymentGatewayInitializeTokenization
"""
Tokenize payment method.
@@ -16736,7 +18532,7 @@ type Mutation {
"""The payment flow that the tokenized payment method should support."""
paymentFlowToSupport: TokenizedPaymentFlowEnum!
- ): PaymentMethodInitializeTokenization @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_METHOD_INITIALIZE_TOKENIZATION_SESSION])
+ ): PaymentMethodInitializeTokenization
"""
Tokenize payment method.
@@ -16757,7 +18553,7 @@ type Mutation {
The identifier of the payment gateway app to process payment method tokenization.
"""
id: String!
- ): PaymentMethodProcessTokenization @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION])
+ ): PaymentMethodProcessTokenization
"""
Creates a new page.
@@ -16767,7 +18563,7 @@ type Mutation {
pageCreate(
"""Fields required to create a page."""
input: PageCreateInput!
- ): PageCreate @doc(category: "Pages")
+ ): PageCreate
"""
Deletes a page.
@@ -16777,7 +18573,7 @@ type Mutation {
pageDelete(
"""ID of a page to delete."""
id: ID!
- ): PageDelete @doc(category: "Pages")
+ ): PageDelete
"""
Deletes pages.
@@ -16787,7 +18583,7 @@ type Mutation {
pageBulkDelete(
"""List of page IDs to delete."""
ids: [ID!]!
- ): PageBulkDelete @doc(category: "Pages")
+ ): PageBulkDelete
"""
Publish pages.
@@ -16800,7 +18596,7 @@ type Mutation {
"""Determine if pages will be published or not."""
isPublished: Boolean!
- ): PageBulkPublish @doc(category: "Pages")
+ ): PageBulkPublish
"""
Updates an existing page.
@@ -16813,7 +18609,7 @@ type Mutation {
"""Fields required to update a page."""
input: PageInput!
- ): PageUpdate @doc(category: "Pages")
+ ): PageUpdate
"""
Creates/updates translations for a page.
@@ -16829,7 +18625,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): PageTranslate @doc(category: "Pages")
+ ): PageTranslate
"""
Creates a new page type.
@@ -16839,7 +18635,7 @@ type Mutation {
pageTypeCreate(
"""Fields required to create page type."""
input: PageTypeCreateInput!
- ): PageTypeCreate @doc(category: "Pages")
+ ): PageTypeCreate
"""
Updates page type.
@@ -16852,7 +18648,7 @@ type Mutation {
"""Fields required to update page type."""
input: PageTypeUpdateInput!
- ): PageTypeUpdate @doc(category: "Pages")
+ ): PageTypeUpdate
"""
Deletes a page type.
@@ -16862,7 +18658,7 @@ type Mutation {
pageTypeDelete(
"""ID of the page type to delete."""
id: ID!
- ): PageTypeDelete @doc(category: "Pages")
+ ): PageTypeDelete
"""
Deletes page types.
@@ -16872,7 +18668,7 @@ type Mutation {
pageTypeBulkDelete(
"""List of page type IDs to delete"""
ids: [ID!]!
- ): PageTypeBulkDelete @doc(category: "Pages")
+ ): PageTypeBulkDelete
"""
Assign attributes to a given page type.
@@ -16885,7 +18681,7 @@ type Mutation {
"""ID of the page type to assign the attributes into."""
pageTypeId: ID!
- ): PageAttributeAssign @doc(category: "Pages")
+ ): PageAttributeAssign
"""
Unassign attributes from a given page type.
@@ -16898,7 +18694,7 @@ type Mutation {
"""ID of the page type from which the attributes should be unassign."""
pageTypeId: ID!
- ): PageAttributeUnassign @doc(category: "Pages")
+ ): PageAttributeUnassign
"""
Reorder the attributes of a page type.
@@ -16911,7 +18707,7 @@ type Mutation {
"""ID of a page type."""
pageTypeId: ID!
- ): PageTypeReorderAttributes @doc(category: "Pages")
+ ): PageTypeReorderAttributes
"""
Reorder page attribute values.
@@ -16927,7 +18723,7 @@ type Mutation {
"""ID of a page."""
pageId: ID!
- ): PageReorderAttributeValues @doc(category: "Pages")
+ ): PageReorderAttributeValues
"""
Completes creating an order.
@@ -16937,7 +18733,7 @@ type Mutation {
draftOrderComplete(
"""ID of the order that will be completed."""
id: ID!
- ): DraftOrderComplete @doc(category: "Orders")
+ ): DraftOrderComplete
"""
Creates a new draft order.
@@ -16947,7 +18743,7 @@ type Mutation {
draftOrderCreate(
"""Fields required to create an order."""
input: DraftOrderCreateInput!
- ): DraftOrderCreate @doc(category: "Orders")
+ ): DraftOrderCreate
"""
Deletes a draft order.
@@ -16960,7 +18756,7 @@ type Mutation {
"""ID of a product to delete."""
id: ID
- ): DraftOrderDelete @doc(category: "Orders")
+ ): DraftOrderDelete
"""
Deletes draft orders.
@@ -16970,7 +18766,7 @@ type Mutation {
draftOrderBulkDelete(
"""List of draft order IDs to delete."""
ids: [ID!]!
- ): DraftOrderBulkDelete @doc(category: "Orders")
+ ): DraftOrderBulkDelete
"""
Deletes order lines.
@@ -16980,7 +18776,7 @@ type Mutation {
draftOrderLinesBulkDelete(
"""List of order lines IDs to delete."""
ids: [ID!]!
- ): DraftOrderLinesBulkDelete @doc(category: "Orders") @deprecated
+ ): DraftOrderLinesBulkDelete @deprecated
"""
Updates a draft order.
@@ -16996,7 +18792,7 @@ type Mutation {
"""Fields required to update an order."""
input: DraftOrderInput!
- ): DraftOrderUpdate @doc(category: "Orders")
+ ): DraftOrderUpdate
"""
Adds note to the order.
@@ -17009,7 +18805,7 @@ type Mutation {
"""Fields required to create a note for the order."""
input: OrderAddNoteInput!
- ): OrderAddNote @doc(category: "Orders") @deprecated(reason: "Use `orderNoteAdd` instead.")
+ ): OrderAddNote @deprecated(reason: "Use `orderNoteAdd` instead.")
"""
Cancel an order.
@@ -17019,7 +18815,7 @@ type Mutation {
orderCancel(
"""ID of the order to cancel."""
id: ID!
- ): OrderCancel @doc(category: "Orders")
+ ): OrderCancel
"""
Capture an order.
@@ -17032,7 +18828,7 @@ type Mutation {
"""ID of the order to capture."""
id: ID!
- ): OrderCapture @doc(category: "Orders")
+ ): OrderCapture
"""
Confirms an unconfirmed order by changing status to unfulfilled.
@@ -17042,7 +18838,7 @@ type Mutation {
orderConfirm(
"""ID of an order to confirm."""
id: ID!
- ): OrderConfirm @doc(category: "Orders")
+ ): OrderConfirm
"""
Creates new fulfillments for an order.
@@ -17061,7 +18857,7 @@ type Mutation {
"""ID of the order to be fulfilled."""
order: ID
- ): OrderFulfill @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_CREATED, ORDER_FULFILLED, FULFILLMENT_TRACKING_NUMBER_UPDATED, FULFILLMENT_APPROVED], syncEvents: [])
+ ): OrderFulfill
"""
Cancels existing fulfillment and optionally restocks items.
@@ -17074,7 +18870,7 @@ type Mutation {
"""Fields required to cancel a fulfillment."""
input: FulfillmentCancelInput
- ): FulfillmentCancel @doc(category: "Orders")
+ ): FulfillmentCancel
"""
Approve existing fulfillment.
@@ -17093,7 +18889,7 @@ type Mutation {
"""True if confirmation email should be send."""
notifyCustomer: Boolean!
- ): FulfillmentApprove @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_APPROVED], syncEvents: [])
+ ): FulfillmentApprove
"""
Updates a fulfillment for an order.
@@ -17109,7 +18905,7 @@ type Mutation {
"""Fields required to update a fulfillment."""
input: FulfillmentUpdateTrackingInput!
- ): FulfillmentUpdateTracking @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_TRACKING_NUMBER_UPDATED], syncEvents: [])
+ ): FulfillmentUpdateTracking
"""
Refund products.
@@ -17122,7 +18918,7 @@ type Mutation {
"""ID of the order to be refunded."""
order: ID!
- ): FulfillmentRefundProducts @doc(category: "Orders")
+ ): FulfillmentRefundProducts
"""
Return products.
@@ -17135,7 +18931,7 @@ type Mutation {
"""ID of the order to be returned."""
order: ID!
- ): FulfillmentReturnProducts @doc(category: "Orders")
+ ): FulfillmentReturnProducts
"""
Adds granted refund to the order.
@@ -17148,7 +18944,7 @@ type Mutation {
"""Fields required to create a granted refund for the order."""
input: OrderGrantRefundCreateInput!
- ): OrderGrantRefundCreate @doc(category: "Orders")
+ ): OrderGrantRefundCreate
"""
Updates granted refund.
@@ -17161,7 +18957,7 @@ type Mutation {
"""Fields required to update a granted refund."""
input: OrderGrantRefundUpdateInput!
- ): OrderGrantRefundUpdate @doc(category: "Orders")
+ ): OrderGrantRefundUpdate
"""
Creates order lines for an order.
@@ -17174,7 +18970,7 @@ type Mutation {
"""Fields required to add order lines."""
input: [OrderLineCreateInput!]!
- ): OrderLinesCreate @doc(category: "Orders")
+ ): OrderLinesCreate
"""
Deletes an order line from an order.
@@ -17184,7 +18980,7 @@ type Mutation {
orderLineDelete(
"""ID of the order line to delete."""
id: ID!
- ): OrderLineDelete @doc(category: "Orders")
+ ): OrderLineDelete
"""
Updates an order line of an order.
@@ -17197,7 +18993,7 @@ type Mutation {
"""Fields required to update an order line."""
input: OrderLineInput!
- ): OrderLineUpdate @doc(category: "Orders")
+ ): OrderLineUpdate
"""
Adds discount to the order.
@@ -17210,7 +19006,7 @@ type Mutation {
"""ID of an order to discount."""
orderId: ID!
- ): OrderDiscountAdd @doc(category: "Orders")
+ ): OrderDiscountAdd
"""
Update discount for the order.
@@ -17223,7 +19019,7 @@ type Mutation {
"""Fields required to update a discount for the order."""
input: OrderDiscountCommonInput!
- ): OrderDiscountUpdate @doc(category: "Orders")
+ ): OrderDiscountUpdate
"""
Remove discount from the order.
@@ -17233,7 +19029,7 @@ type Mutation {
orderDiscountDelete(
"""ID of a discount to remove."""
discountId: ID!
- ): OrderDiscountDelete @doc(category: "Orders")
+ ): OrderDiscountDelete
"""
Update discount for the order line.
@@ -17246,7 +19042,7 @@ type Mutation {
"""ID of a order line to update price"""
orderLineId: ID!
- ): OrderLineDiscountUpdate @doc(category: "Orders")
+ ): OrderLineDiscountUpdate
"""
Remove discount applied to the order line.
@@ -17256,7 +19052,7 @@ type Mutation {
orderLineDiscountRemove(
"""ID of a order line to remove its discount"""
orderLineId: ID!
- ): OrderLineDiscountRemove @doc(category: "Orders")
+ ): OrderLineDiscountRemove
"""
Adds note to the order.
@@ -17269,7 +19065,7 @@ type Mutation {
"""Fields required to create a note for the order."""
input: OrderNoteInput!
- ): OrderNoteAdd @doc(category: "Orders")
+ ): OrderNoteAdd
"""
Updates note of an order.
@@ -17282,7 +19078,7 @@ type Mutation {
"""Fields required to create a note for the order."""
input: OrderNoteInput!
- ): OrderNoteUpdate @doc(category: "Orders")
+ ): OrderNoteUpdate
"""
Mark order as manually paid.
@@ -17295,7 +19091,7 @@ type Mutation {
"""The external transaction reference."""
transactionReference: String
- ): OrderMarkAsPaid @doc(category: "Orders")
+ ): OrderMarkAsPaid
"""
Refund an order.
@@ -17308,7 +19104,7 @@ type Mutation {
"""ID of the order to refund."""
id: ID!
- ): OrderRefund @doc(category: "Orders")
+ ): OrderRefund
"""
Updates an order.
@@ -17324,7 +19120,7 @@ type Mutation {
"""Fields required to update an order."""
input: OrderUpdateInput!
- ): OrderUpdate @doc(category: "Orders")
+ ): OrderUpdate
"""
Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed.
@@ -17337,7 +19133,7 @@ type Mutation {
"""Fields required to change shipping method of the order."""
input: OrderUpdateShippingInput!
- ): OrderUpdateShipping @doc(category: "Orders")
+ ): OrderUpdateShipping
"""
Void an order.
@@ -17347,7 +19143,7 @@ type Mutation {
orderVoid(
"""ID of the order to void."""
id: ID!
- ): OrderVoid @doc(category: "Orders")
+ ): OrderVoid
"""
Cancels orders.
@@ -17357,7 +19153,7 @@ type Mutation {
orderBulkCancel(
"""List of orders IDs to cancel."""
ids: [ID!]!
- ): OrderBulkCancel @doc(category: "Orders")
+ ): OrderBulkCancel
"""
Creates multiple orders.
@@ -17375,7 +19171,7 @@ type Mutation {
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")
+ ): OrderBulkCreate
"""
Delete metadata of an object. To use it, you need to have access to the modified object.
@@ -17436,7 +19232,7 @@ type Mutation {
"""Type of the navigation bar to assign the menu to."""
navigationType: NavigationType!
- ): AssignNavigation @doc(category: "Menu")
+ ): AssignNavigation
"""
Creates a new Menu.
@@ -17449,7 +19245,7 @@ type Mutation {
menuCreate(
"""Fields required to create a menu."""
input: MenuCreateInput!
- ): MenuCreate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_CREATED], syncEvents: [])
+ ): MenuCreate
"""
Deletes a menu.
@@ -17462,7 +19258,7 @@ type Mutation {
menuDelete(
"""ID of a menu to delete."""
id: ID!
- ): MenuDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: [])
+ ): MenuDelete
"""
Deletes menus.
@@ -17475,7 +19271,7 @@ type Mutation {
menuBulkDelete(
"""List of menu IDs to delete."""
ids: [ID!]!
- ): MenuBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: [])
+ ): MenuBulkDelete
"""
Updates a menu.
@@ -17491,7 +19287,7 @@ type Mutation {
"""Fields required to update a menu."""
input: MenuInput!
- ): MenuUpdate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_UPDATED], syncEvents: [])
+ ): MenuUpdate
"""
Creates a new menu item.
@@ -17506,7 +19302,7 @@ type Mutation {
Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
"""
input: MenuItemCreateInput!
- ): MenuItemCreate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_CREATED], syncEvents: [])
+ ): MenuItemCreate
"""
Deletes a menu item.
@@ -17519,7 +19315,7 @@ type Mutation {
menuItemDelete(
"""ID of a menu item to delete."""
id: ID!
- ): MenuItemDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_DELETED], syncEvents: [])
+ ): MenuItemDelete
"""
Deletes menu items.
@@ -17532,7 +19328,7 @@ type Mutation {
menuItemBulkDelete(
"""List of menu item IDs to delete."""
ids: [ID!]!
- ): MenuItemBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_DELETED], syncEvents: [])
+ ): MenuItemBulkDelete
"""
Updates a menu item.
@@ -17550,7 +19346,7 @@ type Mutation {
Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item.
"""
input: MenuItemInput!
- ): MenuItemUpdate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_UPDATED], syncEvents: [])
+ ): MenuItemUpdate
"""
Creates/updates translations for a menu item.
@@ -17566,7 +19362,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): MenuItemTranslate @doc(category: "Menu")
+ ): MenuItemTranslate
"""
Moves items of menus.
@@ -17582,7 +19378,7 @@ type Mutation {
"""The menu position data."""
moves: [MenuItemMoveInput!]!
- ): MenuItemMove @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_UPDATED], syncEvents: [])
+ ): MenuItemMove
"""
Request an invoice for the order using plugin.
@@ -17598,7 +19394,7 @@ type Mutation {
"""ID of the order related to invoice."""
orderId: ID!
- ): InvoiceRequest @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_REQUESTED], syncEvents: [])
+ ): InvoiceRequest
"""
Requests deletion of an invoice.
@@ -17611,7 +19407,7 @@ type Mutation {
invoiceRequestDelete(
"""ID of an invoice to request the deletion."""
id: ID!
- ): InvoiceRequestDelete @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_DELETED], syncEvents: [])
+ ): InvoiceRequestDelete
"""
Creates a ready to send invoice.
@@ -17624,7 +19420,7 @@ type Mutation {
"""ID of the order related to invoice."""
orderId: ID!
- ): InvoiceCreate @doc(category: "Orders")
+ ): InvoiceCreate
"""
Deletes an invoice.
@@ -17634,7 +19430,7 @@ type Mutation {
invoiceDelete(
"""ID of an invoice to delete."""
id: ID!
- ): InvoiceDelete @doc(category: "Orders")
+ ): InvoiceDelete
"""
Updates an invoice.
@@ -17647,7 +19443,7 @@ type Mutation {
"""Fields to use when updating an invoice."""
input: UpdateInvoiceInput!
- ): InvoiceUpdate @doc(category: "Orders")
+ ): InvoiceUpdate
"""
Send an invoice notification to the customer.
@@ -17661,7 +19457,7 @@ type Mutation {
invoiceSendNotification(
"""ID of an invoice to be sent."""
id: ID!
- ): InvoiceSendNotification @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_SENT, NOTIFY_USER], syncEvents: [])
+ ): InvoiceSendNotification
"""
Activate a gift card.
@@ -17674,7 +19470,7 @@ type Mutation {
giftCardActivate(
"""ID of a gift card to activate."""
id: ID!
- ): GiftCardActivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: [])
+ ): GiftCardActivate
"""
Creates a new gift card.
@@ -17688,7 +19484,7 @@ type Mutation {
giftCardCreate(
"""Fields required to create a gift card."""
input: GiftCardCreateInput!
- ): GiftCardCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_CREATED, NOTIFY_USER], syncEvents: [])
+ ): GiftCardCreate
"""
Deletes gift card.
@@ -17701,7 +19497,7 @@ type Mutation {
giftCardDelete(
"""ID of the gift card to delete."""
id: ID!
- ): GiftCardDelete @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_DELETED], syncEvents: [])
+ ): GiftCardDelete
"""
Deactivate a gift card.
@@ -17714,7 +19510,7 @@ type Mutation {
giftCardDeactivate(
"""ID of a gift card to deactivate."""
id: ID!
- ): GiftCardDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: [])
+ ): GiftCardDeactivate
"""
Update a gift card.
@@ -17730,7 +19526,7 @@ type Mutation {
"""Fields required to update a gift card."""
input: GiftCardUpdateInput!
- ): GiftCardUpdate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_UPDATED], syncEvents: [])
+ ): GiftCardUpdate
"""
Resend a gift card.
@@ -17743,7 +19539,7 @@ type Mutation {
giftCardResend(
"""Fields required to resend a gift card."""
input: GiftCardResendInput!
- ): GiftCardResend @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [NOTIFY_USER], syncEvents: [])
+ ): GiftCardResend
"""
Adds note to the gift card.
@@ -17759,7 +19555,7 @@ type Mutation {
"""Fields required to create a note for the gift card."""
input: GiftCardAddNoteInput!
- ): GiftCardAddNote @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_UPDATED], syncEvents: [])
+ ): GiftCardAddNote
"""
Creates gift cards.
@@ -17773,7 +19569,7 @@ type Mutation {
giftCardBulkCreate(
"""Fields required to create gift cards."""
input: GiftCardBulkCreateInput!
- ): GiftCardBulkCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_CREATED, NOTIFY_USER], syncEvents: [])
+ ): GiftCardBulkCreate
"""
Deletes gift cards.
@@ -17786,7 +19582,7 @@ type Mutation {
giftCardBulkDelete(
"""List of gift card IDs to delete."""
ids: [ID!]!
- ): GiftCardBulkDelete @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_DELETED], syncEvents: [])
+ ): GiftCardBulkDelete
"""
Activate gift cards.
@@ -17799,7 +19595,7 @@ type Mutation {
giftCardBulkActivate(
"""List of gift card IDs to activate."""
ids: [ID!]!
- ): GiftCardBulkActivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: [])
+ ): GiftCardBulkActivate
"""
Deactivate gift cards.
@@ -17812,7 +19608,7 @@ type Mutation {
giftCardBulkDeactivate(
"""List of gift card IDs to deactivate."""
ids: [ID!]!
- ): GiftCardBulkDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: [])
+ ): GiftCardBulkDeactivate
"""
Update plugin configuration.
@@ -17858,7 +19654,7 @@ type Mutation {
promotionCreate(
"""Fields requires to create a promotion."""
input: PromotionCreateInput!
- ): PromotionCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_CREATED, PROMOTION_STARTED], syncEvents: [])
+ ): PromotionCreate
"""
Updates an existing promotion.
@@ -17876,7 +19672,7 @@ type Mutation {
"""Fields required to update a promotion."""
input: PromotionUpdateInput!
- ): PromotionUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_UPDATED, PROMOTION_STARTED, PROMOTION_ENDED], syncEvents: [])
+ ): PromotionUpdate
"""
Deletes a promotion.
@@ -17889,7 +19685,7 @@ type Mutation {
promotionDelete(
"""The ID of the promotion to remove."""
id: ID!
- ): PromotionDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_DELETED], syncEvents: [])
+ ): PromotionDelete
"""
Creates a new promotion rule.
@@ -17902,7 +19698,7 @@ type Mutation {
promotionRuleCreate(
"""Fields required to create a promotion rule."""
input: PromotionRuleCreateInput!
- ): PromotionRuleCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_RULE_CREATED], syncEvents: [])
+ ): PromotionRuleCreate
"""
Updates an existing promotion rule.
@@ -17918,7 +19714,7 @@ type Mutation {
"""Fields required to create a promotion rule."""
input: PromotionRuleUpdateInput!
- ): PromotionRuleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_RULE_UPDATED], syncEvents: [])
+ ): PromotionRuleUpdate
"""
Deletes a promotion rule.
@@ -17931,7 +19727,7 @@ type Mutation {
promotionRuleDelete(
"""The ID of the promotion to remove."""
id: ID!
- ): PromotionRuleDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_RULE_DELETED], syncEvents: [])
+ ): PromotionRuleDelete
"""
Creates/updates translations for a promotion.
@@ -17947,7 +19743,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): PromotionTranslate @doc(category: "Discounts")
+ ): PromotionTranslate
"""
Creates/updates translations for a promotion rule.
@@ -17963,7 +19759,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): PromotionRuleTranslate @doc(category: "Discounts")
+ ): PromotionRuleTranslate
"""
Deletes promotions.
@@ -17976,7 +19772,7 @@ type Mutation {
promotionBulkDelete(
"""List of promotion IDs to delete."""
ids: [ID!]!
- ): PromotionBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_DELETED], syncEvents: [])
+ ): PromotionBulkDelete
"""
Creates a new sale.
@@ -17989,7 +19785,7 @@ type Mutation {
saleCreate(
"""Fields required to create a sale."""
input: SaleInput!
- ): SaleCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_CREATED], syncEvents: []) @deprecated(reason: "Use `promotionCreate` mutation instead.")
+ ): SaleCreate @deprecated(reason: "Use `promotionCreate` mutation instead.")
"""
Deletes a sale.
@@ -18002,7 +19798,7 @@ type Mutation {
saleDelete(
"""ID of a sale to delete."""
id: ID!
- ): SaleDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_DELETED], syncEvents: []) @deprecated(reason: "Use `promotionDelete` mutation instead.")
+ ): SaleDelete @deprecated(reason: "Use `promotionDelete` mutation instead.")
"""
Deletes sales.
@@ -18015,7 +19811,7 @@ type Mutation {
saleBulkDelete(
"""List of sale IDs to delete."""
ids: [ID!]!
- ): SaleBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_DELETED], syncEvents: [])
+ ): SaleBulkDelete
"""
Updates a sale.
@@ -18032,7 +19828,7 @@ type Mutation {
"""Fields required to update a sale."""
input: SaleInput!
- ): SaleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED, SALE_TOGGLE], syncEvents: []) @deprecated(reason: "Use `promotionUpdate` mutation instead.")
+ ): SaleUpdate @deprecated(reason: "Use `promotionUpdate` mutation instead.")
"""
Adds products, categories, collections to a sale.
@@ -18048,7 +19844,7 @@ type Mutation {
"""Fields required to modify catalogue IDs of sale."""
input: CatalogueInput!
- ): SaleAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) @deprecated(reason: "Use `promotionRuleCreate` and `promotionRuleUpdate` mutations instead.")
+ ): SaleAddCatalogues @deprecated(reason: "Use `promotionRuleCreate` and `promotionRuleUpdate` mutations instead.")
"""
Removes products, categories, collections from a sale.
@@ -18064,7 +19860,7 @@ type Mutation {
"""Fields required to modify catalogue IDs of sale."""
input: CatalogueInput!
- ): SaleRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) @deprecated(reason: "Use `promotionRuleUpdate` and `promotionRuleDelete` mutations instead.")
+ ): SaleRemoveCatalogues @deprecated(reason: "Use `promotionRuleUpdate` and `promotionRuleDelete` mutations instead.")
"""
Creates/updates translations for a sale.
@@ -18080,7 +19876,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): SaleTranslate @doc(category: "Discounts") @deprecated(reason: "Use `promotionTranslate` mutation instead.")
+ ): SaleTranslate @deprecated(reason: "Use `promotionTranslate` mutation instead.")
"""
Manage sale's availability in channels.
@@ -18093,7 +19889,7 @@ type Mutation {
"""Fields required to update sale channel listings."""
input: SaleChannelListingInput!
- ): SaleChannelListingUpdate @doc(category: "Discounts") @deprecated(reason: "Use `promotionRuleUpdate` mutation instead.")
+ ): SaleChannelListingUpdate @deprecated(reason: "Use `promotionRuleUpdate` mutation instead.")
"""
Creates a new voucher.
@@ -18107,7 +19903,7 @@ type Mutation {
voucherCreate(
"""Fields required to create a voucher."""
input: VoucherInput!
- ): VoucherCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CREATED, VOUCHER_CODES_CREATED], syncEvents: [])
+ ): VoucherCreate
"""
Deletes a voucher.
@@ -18120,7 +19916,7 @@ type Mutation {
voucherDelete(
"""ID of a voucher to delete."""
id: ID!
- ): VoucherDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: [])
+ ): VoucherDelete
"""
Deletes vouchers.
@@ -18133,7 +19929,7 @@ type Mutation {
voucherBulkDelete(
"""List of voucher IDs to delete."""
ids: [ID!]!
- ): VoucherBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: [])
+ ): VoucherBulkDelete
"""
Updates a voucher.
@@ -18150,7 +19946,7 @@ type Mutation {
"""Fields required to update a voucher."""
input: VoucherInput!
- ): VoucherUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED, VOUCHER_CODES_CREATED], syncEvents: [])
+ ): VoucherUpdate
"""
Adds products, categories, collections to a voucher.
@@ -18166,7 +19962,7 @@ type Mutation {
"""Fields required to modify catalogue IDs of voucher."""
input: CatalogueInput!
- ): VoucherAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: [])
+ ): VoucherAddCatalogues
"""
Removes products, categories, collections from a voucher.
@@ -18182,7 +19978,7 @@ type Mutation {
"""Fields required to modify catalogue IDs of voucher."""
input: CatalogueInput!
- ): VoucherRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: [])
+ ): VoucherRemoveCatalogues
"""
Creates/updates translations for a voucher.
@@ -18198,7 +19994,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): VoucherTranslate @doc(category: "Discounts")
+ ): VoucherTranslate
"""
Manage voucher's availability in channels.
@@ -18214,7 +20010,7 @@ type Mutation {
"""Fields required to update voucher channel listings."""
input: VoucherChannelListingInput!
- ): VoucherChannelListingUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: [])
+ ): VoucherChannelListingUpdate
"""
Deletes voucher codes.
@@ -18229,7 +20025,7 @@ type Mutation {
voucherCodeBulkDelete(
"""List of voucher codes IDs to delete."""
ids: [ID!]!
- ): VoucherCodeBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CODES_DELETED], syncEvents: [])
+ ): VoucherCodeBulkDelete
"""
Export products to csv file.
@@ -18243,7 +20039,7 @@ type Mutation {
exportProducts(
"""Fields required to export product data."""
input: ExportProductsInput!
- ): ExportProducts @doc(category: "Products") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, PRODUCT_EXPORT_COMPLETED], syncEvents: [])
+ ): ExportProducts
"""
Export gift cards to csv file.
@@ -18257,7 +20053,7 @@ type Mutation {
exportGiftCards(
"""Fields required to export gift cards data."""
input: ExportGiftCardsInput!
- ): ExportGiftCards @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, GIFT_CARD_EXPORT_COMPLETED], syncEvents: [])
+ ): ExportGiftCards
"""
Export voucher codes to csv/xlsx file.
@@ -18274,7 +20070,7 @@ type Mutation {
exportVoucherCodes(
"""Fields required to export voucher codes."""
input: ExportVoucherCodesInput!
- ): ExportVoucherCodes @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CODE_EXPORT_COMPLETED], syncEvents: [])
+ ): ExportVoucherCodes
"""
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
@@ -18293,8 +20089,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutAddPromoCode(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18302,9 +20102,13 @@ type Mutation {
"""Gift card code or voucher code."""
promoCode: String!
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutAddPromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutAddPromoCode
"""
Updates billing address in the existing checkout.
@@ -18316,8 +20120,12 @@ type Mutation {
"""The billing address of the checkout."""
billingAddress: AddressInput!
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18329,12 +20137,16 @@ type Mutation {
"""
saveAddress: Boolean = true
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
"""The rules for changing validation for received billing address data."""
validationRules: CheckoutAddressValidationRules
- ): CheckoutBillingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ ): CheckoutBillingAddressUpdate
"""
Completes the checkout. As a result a new order is created. The mutation allows to create the unpaid order when setting `orderSettings.allowUnpaidOrders` for given `Channel` is set to `true`. When `orderSettings.allowUnpaidOrders` is set to `false`, checkout can be completed only when attached `Payment`/`TransactionItem`s fully cover the checkout's total. When processing the checkout with `Payment`, in case of required additional confirmation step like 3D secure, the `confirmationNeeded` flag will be set to True and no order will be created until payment is confirmed with second call of this mutation.
@@ -18352,8 +20164,12 @@ type Mutation {
- ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.
"""
checkoutComplete(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18373,12 +20189,20 @@ type Mutation {
"""
redirectUrl: String
- """Determines whether to store the payment source for future usage."""
- storeSource: Boolean = false @deprecated(reason: "Use checkoutPaymentCreate for this action.")
+ """
+ Determines whether to store the payment source for future usage.
+
+ DEPRECATED: this field will be removed. Use checkoutPaymentCreate for this action.
+ """
+ storeSource: Boolean = false
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutComplete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [ORDER_CREATED, NOTIFY_USER, NOTIFY_USER, ORDER_UPDATED, ORDER_PAID, ORDER_FULLY_PAID, ORDER_CONFIRMED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS, CHECKOUT_CALCULATE_TAXES])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutComplete
"""
Create a new checkout.
@@ -18391,13 +20215,13 @@ type Mutation {
checkoutCreate(
"""Fields required to create checkout."""
input: CheckoutCreateInput!
- ): CheckoutCreate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_CREATED], syncEvents: [])
+ ): CheckoutCreate
"""Creates a new checkout from existing order."""
checkoutCreateFromOrder(
"""ID of a order that will be used to create the checkout."""
id: ID!
- ): CheckoutCreateFromOrder @doc(category: "Checkout")
+ ): CheckoutCreateFromOrder
"""
Sets the customer as the owner of the checkout.
@@ -18408,8 +20232,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutCustomerAttach(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. 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.
@@ -18419,9 +20247,13 @@ type Mutation {
"""The checkout's ID."""
id: ID
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutCustomerAttach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutCustomerAttach
"""
Removes the user assigned as the owner of the checkout.
@@ -18432,15 +20264,23 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutCustomerDetach(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutCustomerDetach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutCustomerDetach
"""
Updates customer note in the existing checkout object.
@@ -18456,7 +20296,7 @@ type Mutation {
"""The checkout's ID."""
id: ID!
- ): CheckoutCustomerNoteUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ ): CheckoutCustomerNoteUpdate
"""
Updates email address in the existing checkout object.
@@ -18465,8 +20305,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutEmailUpdate(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""email."""
email: String!
@@ -18474,9 +20318,13 @@ type Mutation {
"""The checkout's ID."""
id: ID
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutEmailUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutEmailUpdate
"""
Deletes a CheckoutLine.
@@ -18485,8 +20333,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutLineDelete(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18494,9 +20346,13 @@ type Mutation {
"""ID of the checkout line to delete."""
lineId: ID
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutLineDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) @deprecated(reason: "Use `checkoutLinesDelete` instead.")
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutLineDelete @deprecated(reason: "Use `checkoutLinesDelete` instead.")
"""
Deletes checkout lines.
@@ -18511,9 +20367,13 @@ type Mutation {
"""A list of checkout lines."""
linesIds: [ID!]!
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutLinesDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutLinesDelete
"""
Adds a checkout line to the existing checkout.If line was already in checkout, its quantity will be increased.
@@ -18522,8 +20382,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutLinesAdd(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18533,9 +20397,13 @@ type Mutation {
"""
lines: [CheckoutLineInput!]!
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutLinesAdd @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutLinesAdd
"""
Updates checkout line in the existing checkout.
@@ -18544,8 +20412,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutLinesUpdate(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18555,9 +20427,13 @@ type Mutation {
"""
lines: [CheckoutLineUpdateInput!]!
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutLinesUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutLinesUpdate
"""
Remove a gift card or a voucher from a checkout.
@@ -18566,8 +20442,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutRemovePromoCode(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18578,14 +20458,22 @@ type Mutation {
"""Gift card or voucher ID."""
promoCodeId: ID
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutRemovePromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutRemovePromoCode
"""Creates a new payment for given checkout."""
checkoutPaymentCreate(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18593,9 +20481,13 @@ type Mutation {
"""Data required to create a new payment."""
input: PaymentInput!
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutPaymentCreate @doc(category: "Checkout")
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutPaymentCreate
"""
Updates shipping address in the existing checkout.
@@ -18604,8 +20496,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutShippingAddressUpdate(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18620,12 +20516,16 @@ type Mutation {
"""The mailing address to where the checkout will be shipped."""
shippingAddress: AddressInput!
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
"""The rules for changing validation for received shipping address data."""
validationRules: CheckoutAddressValidationRules
- ): CheckoutShippingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ ): CheckoutShippingAddressUpdate
"""
Updates the shipping method of the checkout.
@@ -18635,8 +20535,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutShippingMethodUpdate(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18644,9 +20548,13 @@ type Mutation {
"""Shipping method."""
shippingMethodId: ID
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutShippingMethodUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT]) @deprecated(reason: "Use `checkoutDeliveryMethodUpdate` instead.")
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutShippingMethodUpdate @deprecated(reason: "Use `checkoutDeliveryMethodUpdate` instead.")
"""
Updates the delivery method (shipping method or pick up point) of the checkout. Updates the checkout shipping_address for click and collect delivery for a warehouse address.
@@ -18662,9 +20570,13 @@ type Mutation {
"""The checkout's ID."""
id: ID
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutDeliveryMethodUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutDeliveryMethodUpdate
"""
Updates language code in the existing checkout.
@@ -18673,8 +20585,12 @@ type Mutation {
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
checkoutLanguageCodeUpdate(
- """The ID of the checkout."""
- checkoutId: ID @deprecated(reason: "Use `id` instead.")
+ """
+ The ID of the checkout.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ checkoutId: ID
"""The checkout's ID."""
id: ID
@@ -18682,9 +20598,13 @@ type Mutation {
"""New language code."""
languageCode: LanguageCodeEnum!
- """Checkout token."""
- token: UUID @deprecated(reason: "Use `id` instead.")
- ): CheckoutLanguageCodeUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [])
+ """
+ Checkout token.
+
+ DEPRECATED: this field will be removed. Use `id` instead.
+ """
+ token: UUID
+ ): CheckoutLanguageCodeUpdate
"""
Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS.
@@ -18723,7 +20643,7 @@ type Mutation {
Determines if checkout should be removed after creating an order. Default true.
"""
removeCheckout: Boolean = true
- ): OrderCreateFromCheckout @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [ORDER_CREATED, NOTIFY_USER, NOTIFY_USER, ORDER_UPDATED, ORDER_PAID, ORDER_FULLY_PAID, ORDER_CONFIRMED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS, CHECKOUT_CALCULATE_TAXES])
+ ): OrderCreateFromCheckout
"""
Creates a new channel.
@@ -18736,7 +20656,7 @@ type Mutation {
channelCreate(
"""Fields required to create channel."""
input: ChannelCreateInput!
- ): ChannelCreate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_CREATED], syncEvents: [])
+ ): ChannelCreate
"""
Update a channel.
@@ -18756,7 +20676,7 @@ type Mutation {
"""Fields required to update a channel."""
input: ChannelUpdateInput!
- ): ChannelUpdate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_UPDATED, CHANNEL_METADATA_UPDATED], syncEvents: [])
+ ): ChannelUpdate
"""
Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed.
@@ -18772,7 +20692,7 @@ type Mutation {
"""Fields required to delete a channel."""
input: ChannelDeleteInput
- ): ChannelDelete @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_DELETED], syncEvents: [])
+ ): ChannelDelete
"""
Activate a channel.
@@ -18785,7 +20705,7 @@ type Mutation {
channelActivate(
"""ID of the channel to activate."""
id: ID!
- ): ChannelActivate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_STATUS_CHANGED], syncEvents: [])
+ ): ChannelActivate
"""
Deactivate a channel.
@@ -18798,7 +20718,7 @@ type Mutation {
channelDeactivate(
"""ID of the channel to deactivate."""
id: ID!
- ): ChannelDeactivate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_STATUS_CHANGED], syncEvents: [])
+ ): ChannelDeactivate
"""
Reorder the warehouses of a channel.
@@ -18811,7 +20731,7 @@ type Mutation {
"""The list of reordering operations for the given channel warehouses."""
moves: [ReorderInput!]!
- ): ChannelReorderWarehouses @doc(category: "Channels")
+ ): ChannelReorderWarehouses
"""
Creates an attribute.
@@ -18822,7 +20742,7 @@ type Mutation {
attributeCreate(
"""Fields required to create an attribute."""
input: AttributeCreateInput!
- ): AttributeCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_CREATED], syncEvents: [])
+ ): AttributeCreate
"""
Deletes an attribute.
@@ -18838,7 +20758,7 @@ type Mutation {
"""ID of an attribute to delete."""
id: ID
- ): AttributeDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: [])
+ ): AttributeDelete
"""
Updates attribute.
@@ -18857,7 +20777,7 @@ type Mutation {
"""Fields required to update an attribute."""
input: AttributeUpdateInput!
- ): AttributeUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_UPDATED], syncEvents: [])
+ ): AttributeUpdate
"""
Creates attributes.
@@ -18871,7 +20791,7 @@ type Mutation {
"""Policies of error handling. DEFAULT: REJECT_EVERYTHING"""
errorPolicy: ErrorPolicyEnum
- ): AttributeBulkCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_CREATED], syncEvents: [])
+ ): AttributeBulkCreate
"""
Updates attributes.
@@ -18887,7 +20807,7 @@ type Mutation {
"""Policies of error handling. DEFAULT: REJECT_EVERYTHING"""
errorPolicy: ErrorPolicyEnum
- ): AttributeBulkUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_UPDATED, ATTRIBUTE_VALUE_CREATED, ATTRIBUTE_VALUE_DELETED], syncEvents: [])
+ ): AttributeBulkUpdate
"""
Creates/updates translations for an attribute.
@@ -18903,7 +20823,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): AttributeTranslate @doc(category: "Attributes")
+ ): AttributeTranslate
"""
Creates/updates translations for attributes.
@@ -18916,7 +20836,7 @@ type Mutation {
"""List of attributes translations."""
translations: [AttributeBulkTranslateInput!]!
- ): AttributeBulkTranslate @doc(category: "Attributes")
+ ): AttributeBulkTranslate
"""
Deletes attributes.
@@ -18929,7 +20849,7 @@ type Mutation {
attributeBulkDelete(
"""List of attribute IDs to delete."""
ids: [ID!]!
- ): AttributeBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: [])
+ ): AttributeBulkDelete
"""
Deletes values of attributes.
@@ -18943,7 +20863,7 @@ type Mutation {
attributeValueBulkDelete(
"""List of attribute value IDs to delete."""
ids: [ID!]!
- ): AttributeValueBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: [])
+ ): AttributeValueBulkDelete
"""
Creates a value for an attribute.
@@ -18960,7 +20880,7 @@ type Mutation {
"""Fields required to create an AttributeValue."""
input: AttributeValueCreateInput!
- ): AttributeValueCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_CREATED, ATTRIBUTE_UPDATED], syncEvents: [])
+ ): AttributeValueCreate
"""
Deletes a value of an attribute.
@@ -18977,7 +20897,7 @@ type Mutation {
"""ID of a value to delete."""
id: ID
- ): AttributeValueDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: [])
+ ): AttributeValueDelete
"""
Updates value of an attribute.
@@ -18997,7 +20917,7 @@ type Mutation {
"""Fields required to update an AttributeValue."""
input: AttributeValueUpdateInput!
- ): AttributeValueUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_UPDATED, ATTRIBUTE_UPDATED], syncEvents: [])
+ ): AttributeValueUpdate
"""
Creates/updates translations for attribute values.
@@ -19010,7 +20930,7 @@ type Mutation {
"""List of attribute values translations."""
translations: [AttributeValueBulkTranslateInput!]!
- ): AttributeValueBulkTranslate @doc(category: "Attributes")
+ ): AttributeValueBulkTranslate
"""
Creates/updates translations for an attribute value.
@@ -19026,7 +20946,7 @@ type Mutation {
"""Translation language code."""
languageCode: LanguageCodeEnum!
- ): AttributeValueTranslate @doc(category: "Attributes")
+ ): AttributeValueTranslate
"""
Reorder the values of an attribute.
@@ -19043,7 +20963,7 @@ type Mutation {
"""The list of reordering operations for given attribute values."""
moves: [ReorderInput!]!
- ): AttributeReorderValues @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_UPDATED, ATTRIBUTE_UPDATED], syncEvents: [])
+ ): AttributeReorderValues
"""
Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
@@ -19054,7 +20974,7 @@ type Mutation {
appCreate(
"""Fields required to create a new app."""
input: AppInput!
- ): AppCreate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: [])
+ ): AppCreate
"""
Updates an existing app.
@@ -19070,7 +20990,7 @@ type Mutation {
"""Fields required to update an existing app."""
input: AppInput!
- ): AppUpdate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_UPDATED], syncEvents: [])
+ ): AppUpdate
"""
Deletes an app.
@@ -19083,7 +21003,7 @@ type Mutation {
appDelete(
"""ID of an app to delete."""
id: ID!
- ): AppDelete @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_DELETED], syncEvents: [])
+ ): AppDelete
"""
Creates a new token.
@@ -19093,7 +21013,7 @@ type Mutation {
appTokenCreate(
"""Fields required to create a new auth token."""
input: AppTokenInput!
- ): AppTokenCreate @doc(category: "Apps")
+ ): AppTokenCreate
"""
Deletes an authentication token assigned to app.
@@ -19103,13 +21023,13 @@ type Mutation {
appTokenDelete(
"""ID of an auth token to delete."""
id: ID!
- ): AppTokenDelete @doc(category: "Apps")
+ ): AppTokenDelete
"""Verify provided app token."""
appTokenVerify(
"""App token to verify."""
token: String!
- ): AppTokenVerify @doc(category: "Apps")
+ ): AppTokenVerify
"""
Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
@@ -19117,7 +21037,7 @@ type Mutation {
appInstall(
"""Fields required to install a new app."""
input: AppInstallInput!
- ): AppInstall @doc(category: "Apps")
+ ): AppInstall
"""
Retry failed installation of new app.
@@ -19133,7 +21053,7 @@ type Mutation {
"""ID of failed installation."""
id: ID!
- ): AppRetryInstall @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: [])
+ ): AppRetryInstall
"""
Deletes failed installation.
@@ -19143,7 +21063,7 @@ type Mutation {
appDeleteFailedInstallation(
"""ID of failed installation to delete."""
id: ID!
- ): AppDeleteFailedInstallation @doc(category: "Apps")
+ ): AppDeleteFailedInstallation
"""
Fetch and validate manifest.
@@ -19153,7 +21073,7 @@ type Mutation {
appFetchManifest(
"""URL to app's manifest in JSON format."""
manifestUrl: String!
- ): AppFetchManifest @doc(category: "Apps")
+ ): AppFetchManifest
"""
Activate the app.
@@ -19166,7 +21086,7 @@ type Mutation {
appActivate(
"""ID of app to activate."""
id: ID!
- ): AppActivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: [])
+ ): AppActivate
"""
Deactivate the app.
@@ -19179,7 +21099,31 @@ type Mutation {
appDeactivate(
"""ID of app to deactivate."""
id: ID!
- ): AppDeactivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: [])
+ ): AppDeactivate
+
+ """
+ Add a problem to the calling app.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: AUTHENTICATED_APP.
+ """
+ appProblemCreate(
+ """Fields required to create an app problem."""
+ input: AppProblemCreateInput!
+ ): AppProblemCreate
+
+ """
+ Dismiss problems for an app.
+
+ Added in Saleor 3.22.
+
+ Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
+ """
+ appProblemDismiss(
+ """Input for dismissing app problems."""
+ input: AppProblemDismissInput!
+ ): AppProblemDismiss
"""
Re-enable sync webhooks for provided app. Can be used to manually re-enable sync webhooks for the app before the cooldown period ends.
@@ -19191,7 +21135,7 @@ type Mutation {
appReenableSyncWebhooks(
"""The app ID to re-enable sync webhooks for."""
appId: ID!
- ): AppReenableSyncWebhooks @doc(category: "Apps")
+ ): AppReenableSyncWebhooks
"""Create JWT token."""
tokenCreate(
@@ -19205,7 +21149,7 @@ type Mutation {
"""Password of a user."""
password: String!
- ): CreateToken @doc(category: "Authentication")
+ ): CreateToken
"""
Refresh JWT token. Mutation tries to take refreshToken from the input. If it fails it will try to take `refreshToken` from the http-only cookie `refreshToken`. `csrfToken` is required when `refreshToken` is provided as a cookie.
@@ -19218,20 +21162,20 @@ type Mutation {
"""Refresh token."""
refreshToken: String
- ): RefreshToken @doc(category: "Authentication")
+ ): RefreshToken
"""Verify JWT token."""
tokenVerify(
"""JWT token to validate."""
token: String!
- ): VerifyToken @doc(category: "Authentication")
+ ): VerifyToken
"""
Deactivate all JWT tokens of the currently authenticated user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
- tokensDeactivateAll: DeactivateAllUserTokens @doc(category: "Authentication")
+ tokensDeactivateAll: DeactivateAllUserTokens
"""Prepare external authentication URL for user by custom plugin."""
externalAuthenticationUrl(
@@ -19240,7 +21184,7 @@ type Mutation {
"""The ID of the authentication plugin."""
pluginId: String!
- ): ExternalAuthenticationUrl @doc(category: "Authentication")
+ ): ExternalAuthenticationUrl
"""Obtain external access tokens for user by custom plugin."""
externalObtainAccessTokens(
@@ -19249,7 +21193,7 @@ type Mutation {
"""The ID of the authentication plugin."""
pluginId: String!
- ): ExternalObtainAccessTokens @doc(category: "Authentication")
+ ): ExternalObtainAccessTokens
"""Refresh user's access by custom plugin."""
externalRefresh(
@@ -19258,7 +21202,7 @@ type Mutation {
"""The ID of the authentication plugin."""
pluginId: String!
- ): ExternalRefresh @doc(category: "Authentication")
+ ): ExternalRefresh
"""Logout user by custom plugin."""
externalLogout(
@@ -19267,7 +21211,7 @@ type Mutation {
"""The ID of the authentication plugin."""
pluginId: String!
- ): ExternalLogout @doc(category: "Authentication")
+ ): ExternalLogout
"""Verify external authentication data by plugin."""
externalVerify(
@@ -19276,7 +21220,7 @@ type Mutation {
"""The ID of the authentication plugin."""
pluginId: String!
- ): ExternalVerify @doc(category: "Authentication")
+ ): ExternalVerify
"""
Sends an email with the account password modification link.
@@ -19288,7 +21232,7 @@ type Mutation {
"""
requestPasswordReset(
"""
- Slug of a channel which will be used to notify the user. It is needed for customers, if not provided, the notification may not happen. Please note that mutation will not fail if the channel is not provided.
+ Slug of a channel which will be used to notify the user. It is needed for customers, if not provided, the notification may not happen. Please note that mutation will not fail if the channel is not provided.
"""
channel: String
@@ -19299,7 +21243,7 @@ type Mutation {
URL of a view where users should be redirected to reset the password. URL in RFC 1808 format.
"""
redirectUrl: String!
- ): RequestPasswordReset @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_SET_PASSWORD_REQUESTED, STAFF_SET_PASSWORD_REQUESTED], syncEvents: [])
+ ): RequestPasswordReset
"""
Sends a notification confirmation.
@@ -19316,7 +21260,7 @@ type Mutation {
"""Base of frontend URL that will be needed to create confirmation URL."""
redirectUrl: String!
- ): SendConfirmationEmail @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_CONFIRMATION_REQUESTED], syncEvents: [])
+ ): SendConfirmationEmail
"""
Confirm user account with token sent by email during registration.
@@ -19330,7 +21274,7 @@ type Mutation {
"""A one-time token required to confirm the account."""
token: String!
- ): ConfirmAccount @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACCOUNT_CONFIRMED], syncEvents: [])
+ ): ConfirmAccount
"""
Sets the user's password from the token sent by email using the RequestPasswordReset mutation.
@@ -19344,7 +21288,7 @@ type Mutation {
"""A one-time token required to set the password."""
token: String!
- ): SetPassword @doc(category: "Users")
+ ): SetPassword
"""
Change the password of the logged in user.
@@ -19357,7 +21301,7 @@ type Mutation {
"""Current user password."""
oldPassword: String
- ): PasswordChange @doc(category: "Users")
+ ): PasswordChange
"""
Request email change of the logged in user.
@@ -19384,7 +21328,7 @@ type Mutation {
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") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_CHANGE_EMAIL_REQUESTED], syncEvents: [])
+ ): RequestEmailChange
"""
Confirm the email change of the logged-in user.
@@ -19404,7 +21348,7 @@ type Mutation {
"""A one-time token required to change the email."""
token: String!
- ): ConfirmEmailChange @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, NOTIFY_USER, ACCOUNT_EMAIL_CHANGED], syncEvents: [])
+ ): ConfirmEmailChange
"""
Create a new address for the customer.
@@ -19430,7 +21374,7 @@ type Mutation {
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") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, ADDRESS_CREATED], syncEvents: [])
+ ): AccountAddressCreate
"""
Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
@@ -19444,7 +21388,7 @@ type Mutation {
"""Fields required to update the address."""
input: AddressInput!
- ): AccountAddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: [])
+ ): AccountAddressUpdate
"""
Deletes an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
@@ -19455,7 +21399,7 @@ type Mutation {
accountAddressDelete(
"""ID of the address to delete."""
id: ID!
- ): AccountAddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: [])
+ ): AccountAddressDelete
"""
Sets a default address for the authenticated user.
@@ -19471,7 +21415,7 @@ type Mutation {
"""The type of address."""
type: AddressTypeEnum!
- ): AccountSetDefaultAddress @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED], syncEvents: [])
+ ): AccountSetDefaultAddress
"""
Register a new user.
@@ -19484,7 +21428,7 @@ type Mutation {
accountRegister(
"""Fields required to create a user."""
input: AccountRegisterInput!
- ): AccountRegister @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_CREATED, NOTIFY_USER, ACCOUNT_CONFIRMATION_REQUESTED], syncEvents: [])
+ ): AccountRegister
"""
Updates the account of the logged-in user.
@@ -19505,7 +21449,7 @@ type Mutation {
"""Fields required to update the account of the logged-in user."""
input: AccountInput!
- ): AccountUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: [])
+ ): AccountUpdate
"""
Sends an email with the account removal link for the logged-in user.
@@ -19526,7 +21470,7 @@ type Mutation {
URL of a view where users should be redirected to delete their account. URL in RFC 1808 format.
"""
redirectUrl: String!
- ): AccountRequestDeletion @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_DELETE_REQUESTED], syncEvents: [])
+ ): AccountRequestDeletion
"""
Remove user account.
@@ -19541,7 +21485,7 @@ type Mutation {
A one-time token required to remove account. Sent by email using AccountRequestDeletion mutation.
"""
token: String!
- ): AccountDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACCOUNT_DELETED], syncEvents: [])
+ ): AccountDelete
"""
Creates user address.
@@ -19557,7 +21501,7 @@ type Mutation {
"""ID of a user to create address for."""
userId: ID!
- ): AddressCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_CREATED], syncEvents: [])
+ ): AddressCreate
"""
Updates an address.
@@ -19573,7 +21517,7 @@ type Mutation {
"""Fields required to update the address."""
input: AddressInput!
- ): AddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: [])
+ ): AddressUpdate
"""
Deletes an address.
@@ -19586,7 +21530,7 @@ type Mutation {
addressDelete(
"""ID of the address to delete."""
id: ID!
- ): AddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: [])
+ ): AddressDelete
"""
Sets a default address for the given user.
@@ -19605,7 +21549,7 @@ type Mutation {
"""ID of the user to change the address for."""
userId: ID!
- ): AddressSetDefault @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED], syncEvents: [])
+ ): AddressSetDefault
"""
Creates a new customer.
@@ -19621,7 +21565,7 @@ type Mutation {
customerCreate(
"""Fields required to create a customer."""
input: UserCreateInput!
- ): CustomerCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_CREATED, CUSTOMER_METADATA_UPDATED, NOTIFY_USER, ACCOUNT_SET_PASSWORD_REQUESTED], syncEvents: [])
+ ): CustomerCreate
"""
Updates an existing customer.
@@ -19641,7 +21585,7 @@ type Mutation {
"""Fields required to update a customer."""
input: CustomerInput!
- ): CustomerUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: [])
+ ): CustomerUpdate
"""
Deletes a customer.
@@ -19657,7 +21601,7 @@ type Mutation {
"""ID of a customer to delete."""
id: ID
- ): CustomerDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_DELETED], syncEvents: [])
+ ): CustomerDelete
"""
Deletes customers.
@@ -19670,7 +21614,7 @@ type Mutation {
customerBulkDelete(
"""List of user IDs to delete."""
ids: [ID!]!
- ): CustomerBulkDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_DELETED], syncEvents: [])
+ ): CustomerBulkDelete
"""
Updates customers.
@@ -19687,7 +21631,7 @@ type Mutation {
"""Policies of error handling. DEFAULT: REJECT_EVERYTHING"""
errorPolicy: ErrorPolicyEnum
- ): CustomerBulkUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: [])
+ ): CustomerBulkUpdate
"""
Creates a new staff user. Apps are not allowed to perform this mutation.
@@ -19702,7 +21646,7 @@ type Mutation {
staffCreate(
"""Fields required to create a staff user."""
input: StaffCreateInput!
- ): StaffCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_CREATED, NOTIFY_USER, STAFF_SET_PASSWORD_REQUESTED], syncEvents: [])
+ ): StaffCreate
"""
Updates an existing staff user. Apps are not allowed to perform this mutation.
@@ -19718,7 +21662,7 @@ type Mutation {
"""Fields required to update a staff user."""
input: StaffUpdateInput!
- ): StaffUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_UPDATED], syncEvents: [])
+ ): StaffUpdate
"""
Deletes a staff user. Apps are not allowed to perform this mutation.
@@ -19731,7 +21675,7 @@ type Mutation {
staffDelete(
"""ID of a staff user to delete."""
id: ID!
- ): StaffDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: [])
+ ): StaffDelete
"""
Deletes staff users. Apps are not allowed to perform this mutation.
@@ -19744,7 +21688,7 @@ type Mutation {
staffBulkDelete(
"""List of user IDs to delete."""
ids: [ID!]!
- ): StaffBulkDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: [])
+ ): StaffBulkDelete
"""
Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec
@@ -19754,14 +21698,14 @@ type Mutation {
userAvatarUpdate(
"""Represents an image file in a multipart request."""
image: Upload!
- ): UserAvatarUpdate @doc(category: "Users")
+ ): UserAvatarUpdate
"""
Deletes a user avatar. Only for staff members.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
- userAvatarDelete: UserAvatarDelete @doc(category: "Users")
+ userAvatarDelete: UserAvatarDelete
"""
Activate or deactivate users.
@@ -19774,7 +21718,7 @@ type Mutation {
"""Determine if users will be set active or not."""
isActive: Boolean!
- ): UserBulkSetActive @doc(category: "Users")
+ ): UserBulkSetActive
"""
Create new permission group. Apps are not allowed to perform this mutation.
@@ -19787,7 +21731,7 @@ type Mutation {
permissionGroupCreate(
"""Input fields to create permission group."""
input: PermissionGroupCreateInput!
- ): PermissionGroupCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_CREATED], syncEvents: [])
+ ): PermissionGroupCreate
"""
Update permission group. Apps are not allowed to perform this mutation.
@@ -19803,7 +21747,7 @@ type Mutation {
"""Input fields to create permission group."""
input: PermissionGroupUpdateInput!
- ): PermissionGroupUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_UPDATED], syncEvents: [])
+ ): PermissionGroupUpdate
"""
Delete permission group. Apps are not allowed to perform this mutation.
@@ -19816,7 +21760,7 @@ type Mutation {
permissionGroupDelete(
"""ID of the group to delete."""
id: ID!
- ): PermissionGroupDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_DELETED], syncEvents: [])
+ ): PermissionGroupDelete
}
"""
@@ -19824,13 +21768,13 @@ Creates a new webhook subscription.
Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
"""
-type WebhookCreate @doc(category: "Webhooks") {
+type WebhookCreate {
webhookErrors: [WebhookError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WebhookError!]!
webhook: Webhook
}
-type WebhookError @doc(category: "Webhooks") {
+type WebhookError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -19843,7 +21787,7 @@ type WebhookError @doc(category: "Webhooks") {
code: WebhookErrorCode!
}
-enum WebhookErrorCode @doc(category: "Webhooks") {
+enum WebhookErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -19858,15 +21802,19 @@ enum WebhookErrorCode @doc(category: "Webhooks") {
INVALID_NOTIFY_WITH_SUBSCRIPTION
}
-input WebhookCreateInput @doc(category: "Webhooks") {
+input WebhookCreateInput {
"""The name of the webhook."""
name: String
"""The url to receive the payload."""
targetUrl: String
- """The events that webhook wants to subscribe."""
- events: [WebhookEventTypeEnum!] @deprecated(reason: "Use `asyncEvents` or `syncEvents` instead.")
+ """
+ The events that webhook wants to subscribe.
+
+ DEPRECATED: this field will be removed. Use `asyncEvents` or `syncEvents` instead.
+ """
+ events: [WebhookEventTypeEnum!]
"""The asynchronous events that webhook wants to subscribe."""
asyncEvents: [WebhookEventTypeAsyncEnum!]
@@ -19880,8 +21828,12 @@ input WebhookCreateInput @doc(category: "Webhooks") {
"""Determine if webhook will be set active or not."""
isActive: Boolean
- """The secret key used to create a hash signature with each payload."""
- secretKey: String @deprecated(reason: "As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.")
+ """
+ The secret key used to create a hash signature with each payload.
+
+ DEPRECATED: this field will be removed. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.
+ """
+ secretKey: String
"""Subscription query used to define a webhook payload."""
query: String
@@ -19897,7 +21849,7 @@ Deletes a webhook. Before the deletion, the webhook is deactivated to pause any
Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
"""
-type WebhookDelete @doc(category: "Webhooks") {
+type WebhookDelete {
webhookErrors: [WebhookError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WebhookError!]!
webhook: Webhook
@@ -19908,21 +21860,25 @@ Updates a webhook subscription.
Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
"""
-type WebhookUpdate @doc(category: "Webhooks") {
+type WebhookUpdate {
webhookErrors: [WebhookError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WebhookError!]!
webhook: Webhook
}
-input WebhookUpdateInput @doc(category: "Webhooks") {
+input WebhookUpdateInput {
"""The new name of the webhook."""
name: String
"""The url to receive the payload."""
targetUrl: String
- """The events that webhook wants to subscribe."""
- events: [WebhookEventTypeEnum!] @deprecated(reason: "Use `asyncEvents` or `syncEvents` instead.")
+ """
+ The events that webhook wants to subscribe.
+
+ DEPRECATED: this field will be removed. Use `asyncEvents` or `syncEvents` instead.
+ """
+ events: [WebhookEventTypeEnum!]
"""The asynchronous events that webhook wants to subscribe."""
asyncEvents: [WebhookEventTypeAsyncEnum!]
@@ -19936,8 +21892,12 @@ input WebhookUpdateInput @doc(category: "Webhooks") {
"""Determine if webhook will be set active or not."""
isActive: Boolean
- """Use to create a hash signature with each payload."""
- secretKey: String @deprecated(reason: "As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.")
+ """
+ Use to create a hash signature with each payload.
+
+ DEPRECATED: this field will be removed. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.
+ """
+ secretKey: String
"""Subscription query used to define a webhook payload."""
query: String
@@ -19953,7 +21913,7 @@ Retries event delivery.
Requires one of the following permissions: MANAGE_APPS.
"""
-type EventDeliveryRetry @doc(category: "Webhooks") {
+type EventDeliveryRetry {
"""Event delivery."""
delivery: EventDelivery
errors: [WebhookError!]!
@@ -19964,13 +21924,13 @@ Performs a dry run of a webhook event. Supports a single event (the first, if mu
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
-type WebhookDryRun @doc(category: "Webhooks") {
+type WebhookDryRun {
"""JSON payload, that would be sent out to webhook's target URL."""
payload: JSONString
errors: [WebhookDryRunError!]!
}
-type WebhookDryRunError @doc(category: "Webhooks") {
+type WebhookDryRunError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -19983,7 +21943,7 @@ type WebhookDryRunError @doc(category: "Webhooks") {
code: WebhookDryRunErrorCode!
}
-enum WebhookDryRunErrorCode @doc(category: "Webhooks") {
+enum WebhookDryRunErrorCode {
GRAPHQL_ERROR
NOT_FOUND
INVALID_ID
@@ -20000,12 +21960,12 @@ Trigger a webhook event. Supports a single event (the first, if multiple provide
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
-type WebhookTrigger @doc(category: "Webhooks") {
+type WebhookTrigger {
delivery: EventDelivery
errors: [WebhookTriggerError!]!
}
-type WebhookTriggerError @doc(category: "Webhooks") {
+type WebhookTriggerError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20018,7 +21978,7 @@ type WebhookTriggerError @doc(category: "Webhooks") {
code: WebhookTriggerErrorCode!
}
-enum WebhookTriggerErrorCode @doc(category: "Webhooks") {
+enum WebhookTriggerErrorCode {
GRAPHQL_ERROR
NOT_FOUND
INVALID_ID
@@ -20036,13 +21996,13 @@ Creates a new warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type WarehouseCreate @doc(category: "Products") {
+type WarehouseCreate {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
}
-type WarehouseError @doc(category: "Products") {
+type WarehouseError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20058,7 +22018,7 @@ type WarehouseError @doc(category: "Products") {
shippingZones: [ID!]
}
-enum WarehouseErrorCode @doc(category: "Products") {
+enum WarehouseErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
@@ -20067,7 +22027,7 @@ enum WarehouseErrorCode @doc(category: "Products") {
UNIQUE
}
-input WarehouseCreateInput @doc(category: "Products") {
+input WarehouseCreateInput {
"""Warehouse slug."""
slug: String
@@ -20083,8 +22043,12 @@ input WarehouseCreateInput @doc(category: "Products") {
"""Address of the warehouse."""
address: AddressInput!
- """Shipping zones supported by the warehouse."""
- shippingZones: [ID!] @deprecated(reason: "Providing the zone ids will raise a ValidationError.")
+ """
+ Shipping zones supported by the warehouse.
+
+ DEPRECATED: this field will be removed. Providing the zone ids will raise a ValidationError.
+ """
+ shippingZones: [ID!]
}
"""
@@ -20092,13 +22056,13 @@ Updates given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type WarehouseUpdate @doc(category: "Products") {
+type WarehouseUpdate {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
}
-input WarehouseUpdateInput @doc(category: "Products") {
+input WarehouseUpdateInput {
"""Warehouse slug."""
slug: String
@@ -20126,7 +22090,7 @@ Deletes selected warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type WarehouseDelete @doc(category: "Products") {
+type WarehouseDelete {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
@@ -20137,7 +22101,7 @@ Add shipping zone to given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type WarehouseShippingZoneAssign @doc(category: "Products") {
+type WarehouseShippingZoneAssign {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
@@ -20148,7 +22112,7 @@ Remove shipping zone from given warehouse.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type WarehouseShippingZoneUnassign @doc(category: "Products") {
+type WarehouseShippingZoneUnassign {
warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [WarehouseError!]!
warehouse: Warehouse
@@ -20159,12 +22123,12 @@ Creates a tax class.
Requires one of the following permissions: MANAGE_TAXES.
"""
-type TaxClassCreate @doc(category: "Taxes") {
+type TaxClassCreate {
errors: [TaxClassCreateError!]!
taxClass: TaxClass
}
-type TaxClassCreateError @doc(category: "Taxes") {
+type TaxClassCreateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20180,13 +22144,13 @@ type TaxClassCreateError @doc(category: "Taxes") {
countryCodes: [String!]!
}
-enum TaxClassCreateErrorCode @doc(category: "Taxes") {
+enum TaxClassCreateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
-input TaxClassCreateInput @doc(category: "Taxes") {
+input TaxClassCreateInput {
"""Name of the tax class."""
name: String!
@@ -20194,7 +22158,7 @@ input TaxClassCreateInput @doc(category: "Taxes") {
createCountryRates: [CountryRateInput!]
}
-input CountryRateInput @doc(category: "Taxes") {
+input CountryRateInput {
"""Country in which this rate applies."""
countryCode: CountryCode!
@@ -20209,12 +22173,12 @@ Deletes a tax class. After deleting the tax class any products, product types or
Requires one of the following permissions: MANAGE_TAXES.
"""
-type TaxClassDelete @doc(category: "Taxes") {
+type TaxClassDelete {
errors: [TaxClassDeleteError!]!
taxClass: TaxClass
}
-type TaxClassDeleteError @doc(category: "Taxes") {
+type TaxClassDeleteError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20227,7 +22191,7 @@ type TaxClassDeleteError @doc(category: "Taxes") {
code: TaxClassDeleteErrorCode!
}
-enum TaxClassDeleteErrorCode @doc(category: "Taxes") {
+enum TaxClassDeleteErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -20238,12 +22202,12 @@ Updates a tax class.
Requires one of the following permissions: MANAGE_TAXES.
"""
-type TaxClassUpdate @doc(category: "Taxes") {
+type TaxClassUpdate {
errors: [TaxClassUpdateError!]!
taxClass: TaxClass
}
-type TaxClassUpdateError @doc(category: "Taxes") {
+type TaxClassUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20259,14 +22223,14 @@ type TaxClassUpdateError @doc(category: "Taxes") {
countryCodes: [String!]!
}
-enum TaxClassUpdateErrorCode @doc(category: "Taxes") {
+enum TaxClassUpdateErrorCode {
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
-input TaxClassUpdateInput @doc(category: "Taxes") {
+input TaxClassUpdateInput {
"""Name of the tax class."""
name: String
@@ -20281,7 +22245,7 @@ input TaxClassUpdateInput @doc(category: "Taxes") {
removeCountryRates: [CountryCode!]
}
-input CountryRateUpdateInput @doc(category: "Taxes") {
+input CountryRateUpdateInput {
"""Country in which this rate applies."""
countryCode: CountryCode!
@@ -20296,12 +22260,12 @@ Updates tax configuration for a channel.
Requires one of the following permissions: MANAGE_TAXES.
"""
-type TaxConfigurationUpdate @doc(category: "Taxes") {
+type TaxConfigurationUpdate {
errors: [TaxConfigurationUpdateError!]!
taxConfiguration: TaxConfiguration
}
-type TaxConfigurationUpdateError @doc(category: "Taxes") {
+type TaxConfigurationUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20317,14 +22281,14 @@ type TaxConfigurationUpdateError @doc(category: "Taxes") {
countryCodes: [String!]!
}
-enum TaxConfigurationUpdateErrorCode @doc(category: "Taxes") {
+enum TaxConfigurationUpdateErrorCode {
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
-input TaxConfigurationUpdateInput @doc(category: "Taxes") {
+input TaxConfigurationUpdateInput {
"""Determines whether taxes are charged in the given channel."""
chargeTaxes: Boolean
@@ -20362,7 +22326,7 @@ input TaxConfigurationUpdateInput @doc(category: "Taxes") {
taxAppId: String
}
-input TaxConfigurationPerCountryInput @doc(category: "Taxes") {
+input TaxConfigurationPerCountryInput {
"""Country in which this configuration applies."""
countryCode: CountryCode!
@@ -20399,13 +22363,13 @@ Updates tax class rates for a specific country.
Requires one of the following permissions: MANAGE_TAXES.
"""
-type TaxCountryConfigurationUpdate @doc(category: "Taxes") {
+type TaxCountryConfigurationUpdate {
"""Updated tax class rates grouped by a country."""
taxCountryConfiguration: TaxCountryConfiguration
errors: [TaxCountryConfigurationUpdateError!]!
}
-type TaxCountryConfigurationUpdateError @doc(category: "Taxes") {
+type TaxCountryConfigurationUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20421,7 +22385,7 @@ type TaxCountryConfigurationUpdateError @doc(category: "Taxes") {
taxClassIds: [String!]!
}
-enum TaxCountryConfigurationUpdateErrorCode @doc(category: "Taxes") {
+enum TaxCountryConfigurationUpdateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -20429,7 +22393,7 @@ enum TaxCountryConfigurationUpdateErrorCode @doc(category: "Taxes") {
CANNOT_CREATE_NEGATIVE_RATE
}
-input TaxClassRateInput @doc(category: "Taxes") {
+input TaxClassRateInput {
"""ID of a tax class for which to update the tax rate"""
taxClassId: ID
@@ -20442,13 +22406,13 @@ Remove all tax class rates for a specific country.
Requires one of the following permissions: MANAGE_TAXES.
"""
-type TaxCountryConfigurationDelete @doc(category: "Taxes") {
+type TaxCountryConfigurationDelete {
"""Updated tax class rates grouped by a country."""
taxCountryConfiguration: TaxCountryConfiguration
errors: [TaxCountryConfigurationDeleteError!]!
}
-type TaxCountryConfigurationDeleteError @doc(category: "Taxes") {
+type TaxCountryConfigurationDeleteError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20461,7 +22425,7 @@ type TaxCountryConfigurationDeleteError @doc(category: "Taxes") {
code: TaxCountryConfigurationDeleteErrorCode!
}
-enum TaxCountryConfigurationDeleteErrorCode @doc(category: "Taxes") {
+enum TaxCountryConfigurationDeleteErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -20472,14 +22436,14 @@ Exempt checkout or order from charging the taxes. When tax exemption is enabled,
Requires one of the following permissions: MANAGE_TAXES.
"""
-type TaxExemptionManage @doc(category: "Taxes") {
+type TaxExemptionManage {
taxableObject: TaxSourceObject
errors: [TaxExemptionManageError!]!
}
union TaxSourceObject = Checkout | Order
-type TaxExemptionManageError @doc(category: "Taxes") {
+type TaxExemptionManageError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20492,7 +22456,7 @@ type TaxExemptionManageError @doc(category: "Taxes") {
code: TaxExemptionManageErrorCode!
}
-enum TaxExemptionManageErrorCode @doc(category: "Taxes") {
+enum TaxExemptionManageErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -20507,7 +22471,7 @@ Requires one of the following permissions: MANAGE_PRODUCTS.
Triggers the following webhook events:
- PRODUCT_VARIANT_STOCK_UPDATED (async): A product variant stock details were updated.
"""
-type StockBulkUpdate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [PRODUCT_VARIANT_STOCK_UPDATED], syncEvents: []) {
+type StockBulkUpdate {
"""Returns how many objects were updated."""
count: Int!
@@ -20516,7 +22480,7 @@ type StockBulkUpdate @doc(category: "Products") @webhookEventsInfo(asyncEvents:
errors: [StockBulkUpdateError!]!
}
-type StockBulkResult @doc(category: "Products") {
+type StockBulkResult {
"""Stock data."""
stock: Stock
@@ -20524,7 +22488,7 @@ type StockBulkResult @doc(category: "Products") {
errors: [StockBulkUpdateError!]
}
-type StockBulkUpdateError @doc(category: "Products") {
+type StockBulkUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20537,7 +22501,7 @@ type StockBulkUpdateError @doc(category: "Products") {
code: StockBulkUpdateErrorCode!
}
-enum StockBulkUpdateErrorCode @doc(category: "Products") {
+enum StockBulkUpdateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -20557,7 +22521,7 @@ enum ErrorPolicyEnum {
REJECT_FAILED_ROWS
}
-input StockBulkUpdateInput @doc(category: "Products") {
+input StockBulkUpdateInput {
"""Variant ID."""
variantId: ID
@@ -20579,13 +22543,13 @@ Creates a new staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type StaffNotificationRecipientCreate @doc(category: "Users") {
+type StaffNotificationRecipientCreate {
shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
}
-type ShopError @doc(category: "Shop") {
+type ShopError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20624,7 +22588,7 @@ Updates a staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type StaffNotificationRecipientUpdate @doc(category: "Users") {
+type StaffNotificationRecipientUpdate {
shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
@@ -20635,7 +22599,7 @@ Deletes staff notification recipient.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type StaffNotificationRecipientDelete @doc(category: "Users") {
+type StaffNotificationRecipientDelete {
shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShopError!]!
staffNotificationRecipient: StaffNotificationRecipient
@@ -20646,7 +22610,7 @@ Updates site domain of the shop.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type ShopDomainUpdate @doc(category: "Shop") {
+type ShopDomainUpdate {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -20669,7 +22633,7 @@ Requires one of the following permissions: MANAGE_SETTINGS.
Triggers the following webhook events:
- SHOP_METADATA_UPDATED (async): Optionally triggered when public or private metadata is updated.
"""
-type ShopSettingsUpdate @doc(category: "Shop") @webhookEventsInfo(asyncEvents: [SHOP_METADATA_UPDATED], syncEvents: []) {
+type ShopSettingsUpdate {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -20750,21 +22714,35 @@ input ShopSettingsInput {
"""
privateMetadata: [MetadataInput!]
- """Include taxes in prices."""
- includeTaxesInPrices: Boolean @deprecated(reason: "Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.")
+ """
+ Include taxes in prices.
+
+ DEPRECATED: this field will be removed. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.
+ """
+ includeTaxesInPrices: Boolean
- """Display prices with tax in store."""
- displayGrossPrices: Boolean @deprecated(reason: "Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.")
+ """
+ Display prices with tax in store.
+
+ DEPRECATED: this field will be removed. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.
+ """
+ displayGrossPrices: Boolean
- """Charge taxes on shipping."""
- chargeTaxesOnShipping: Boolean @deprecated(reason: "To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations.")
+ """
+ Charge taxes on shipping.
+
+ DEPRECATED: this field will be removed. To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations.
+ """
+ chargeTaxesOnShipping: Boolean
"""
Use legacy update webhook emission. When enabled, update webhooks (e.g. `customerUpdated`,`productVariantUpdated`) are sent even when only metadata changes. When disabled, update webhooks are not sent for metadata-only changes; only metadata-specific webhooks (e.g., `customerMetadataUpdated`, `productVariantMetadataUpdated`) are sent.
Added in Saleor 3.22.
+
+ DEPRECATED: this field will be removed.
"""
- useLegacyUpdateWebhookEmission: Boolean @deprecated
+ useLegacyUpdateWebhookEmission: Boolean
}
"""
@@ -20772,7 +22750,7 @@ Fetch tax rates.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type ShopFetchTaxRates @doc(category: "Shop") {
+type ShopFetchTaxRates {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -20784,7 +22762,7 @@ Creates/updates translations for shop settings.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type ShopSettingsTranslate @doc(category: "Shop") {
+type ShopSettingsTranslate {
"""Updated shop settings."""
shop: Shop
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -20822,7 +22800,7 @@ Update the shop's address. If the `null` value is passed, the currently selected
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type ShopAddressUpdate @doc(category: "Shop") {
+type ShopAddressUpdate {
"""Updated shop."""
shop: Shop
shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -20834,14 +22812,14 @@ Update shop order settings across all channels. Returns `orderSettings` for the
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderSettingsUpdate @doc(category: "Orders") {
+type OrderSettingsUpdate {
"""Order settings."""
orderSettings: OrderSettings
orderSettingsErrors: [OrderSettingsError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [OrderSettingsError!]!
}
-type OrderSettingsError @doc(category: "Orders") {
+type OrderSettingsError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20854,11 +22832,11 @@ type OrderSettingsError @doc(category: "Orders") {
code: OrderSettingsErrorCode!
}
-enum OrderSettingsErrorCode @doc(category: "Orders") {
+enum OrderSettingsErrorCode {
INVALID
}
-input OrderSettingsUpdateInput @doc(category: "Orders") {
+input OrderSettingsUpdateInput {
"""
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
"""
@@ -20875,13 +22853,13 @@ Update gift card settings.
Requires one of the following permissions: MANAGE_GIFT_CARD.
"""
-type GiftCardSettingsUpdate @doc(category: "Gift cards") {
+type GiftCardSettingsUpdate {
"""Gift card settings."""
giftCardSettings: GiftCardSettings
errors: [GiftCardSettingsError!]!
}
-type GiftCardSettingsError @doc(category: "Gift cards") {
+type GiftCardSettingsError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20894,13 +22872,13 @@ type GiftCardSettingsError @doc(category: "Gift cards") {
code: GiftCardSettingsErrorCode!
}
-enum GiftCardSettingsErrorCode @doc(category: "Gift cards") {
+enum GiftCardSettingsErrorCode {
INVALID
REQUIRED
GRAPHQL_ERROR
}
-input GiftCardSettingsUpdateInput @doc(category: "Gift cards") {
+input GiftCardSettingsUpdateInput {
"""Defines gift card default expiry settings."""
expiryType: GiftCardSettingsExpiryTypeEnum
@@ -20923,14 +22901,14 @@ Added in Saleor 3.22.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type RefundSettingsUpdate @doc(category: "Shop") {
+type RefundSettingsUpdate {
"""Refund settings."""
refundSettings: RefundSettings!
refundSettingsErrors: [RefundSettingsUpdateError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [RefundSettingsUpdateError!]!
}
-type RefundSettingsUpdateError @doc(category: "Shop") {
+type RefundSettingsUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20943,13 +22921,13 @@ type RefundSettingsUpdateError @doc(category: "Shop") {
code: RefundSettingsErrorCode!
}
-enum RefundSettingsErrorCode @doc(category: "Shop") {
+enum RefundSettingsErrorCode {
INVALID
REQUIRED
GRAPHQL_ERROR
}
-input RefundSettingsUpdateInput @doc(category: "Shop") {
+input RefundSettingsUpdateInput {
"""
The ID of a model type, that will be used to reference refund reasons. All models with of this type will be accepted as refund reasons.
@@ -20965,14 +22943,14 @@ Added in Saleor 3.22.
Requires one of the following permissions: MANAGE_SETTINGS.
"""
-type RefundReasonReferenceTypeClear @doc(category: "Orders") {
+type RefundReasonReferenceTypeClear {
"""Refund settings."""
refundSettings: RefundSettings!
refundSettingsErrors: [RefundReasonReferenceTypeClearError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [RefundReasonReferenceTypeClearError!]!
}
-type RefundReasonReferenceTypeClearError @doc(category: "Shop") {
+type RefundReasonReferenceTypeClearError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -20985,19 +22963,88 @@ type RefundReasonReferenceTypeClearError @doc(category: "Shop") {
code: RefundSettingsErrorCode!
}
+"""
+Update return settings across all channels.
+
+Added in Saleor 3.22.
+
+Requires one of the following permissions: MANAGE_SETTINGS.
+"""
+type ReturnSettingsUpdate {
+ """Return settings."""
+ returnSettings: ReturnSettings!
+ returnSettingsErrors: [ReturnSettingsUpdateError!]! @deprecated(reason: "Use `errors` field instead.")
+ errors: [ReturnSettingsUpdateError!]!
+}
+
+type ReturnSettingsUpdateError {
+ """
+ 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
+
+ """Failed to update Return Settings"""
+ code: ReturnSettingsErrorCode!
+}
+
+enum ReturnSettingsErrorCode {
+ INVALID
+ REQUIRED
+ GRAPHQL_ERROR
+}
+
+input ReturnSettingsUpdateInput {
+ """
+ The ID of a model type, that will be used to reference return reasons. All models with of this type will be accepted as return reasons.
+
+ Added in Saleor 3.22.
+ """
+ returnReasonReferenceType: ID!
+}
+
+"""
+Updates ReturnSettings. The `Page` (Model) Type will be cleared from `reasonReferenceType`. When it's cleared, passing reason reference to return mutations is no longer accepted and will raise error.
+
+Added in Saleor 3.22.
+
+Requires one of the following permissions: MANAGE_SETTINGS.
+"""
+type ReturnReasonReferenceTypeClear {
+ """Return settings."""
+ returnSettings: ReturnSettings!
+ returnSettingsErrors: [ReturnReasonReferenceTypeClearError!]! @deprecated(reason: "Use `errors` field instead.")
+ errors: [ReturnReasonReferenceTypeClearError!]!
+}
+
+type ReturnReasonReferenceTypeClearError {
+ """
+ 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
+
+ """Failed to clear return reason reference type"""
+ code: ReturnSettingsErrorCode!
+}
+
"""
Manage shipping method's availability in channels.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingMethodChannelListingUpdate @doc(category: "Shipping") {
+type ShippingMethodChannelListingUpdate {
"""An updated shipping method instance."""
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShippingError!]!
}
-type ShippingError @doc(category: "Shipping") {
+type ShippingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -21016,7 +23063,7 @@ type ShippingError @doc(category: "Shipping") {
channels: [ID!]
}
-enum ShippingErrorCode @doc(category: "Shipping") {
+enum ShippingErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
@@ -21027,7 +23074,7 @@ enum ShippingErrorCode @doc(category: "Shipping") {
DUPLICATED_INPUT_ITEM
}
-input ShippingMethodChannelListingInput @doc(category: "Shipping") {
+input ShippingMethodChannelListingInput {
"""List of channels to which the shipping method should be assigned."""
addChannels: [ShippingMethodChannelListingAddInput!]
@@ -21035,7 +23082,7 @@ input ShippingMethodChannelListingInput @doc(category: "Shipping") {
removeChannels: [ID!]
}
-input ShippingMethodChannelListingAddInput @doc(category: "Shipping") {
+input ShippingMethodChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
@@ -21054,7 +23101,7 @@ Creates a new shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingPriceCreate @doc(category: "Shipping") {
+type ShippingPriceCreate {
"""A shipping zone to which the shipping method belongs."""
shippingZone: ShippingZone
shippingMethod: ShippingMethodType
@@ -21062,7 +23109,7 @@ type ShippingPriceCreate @doc(category: "Shipping") {
errors: [ShippingError!]!
}
-input ShippingPriceInput @doc(category: "Shipping") {
+input ShippingPriceInput {
"""Name of the shipping method."""
name: String
@@ -21104,7 +23151,7 @@ input ShippingPriceInput @doc(category: "Shipping") {
scalar WeightScalar
-input ShippingPostalCodeRulesCreateInputRange @doc(category: "Shipping") {
+input ShippingPostalCodeRulesCreateInputRange {
"""Start range of the postal code."""
start: String!
@@ -21117,7 +23164,7 @@ Deletes a shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingPriceDelete @doc(category: "Shipping") {
+type ShippingPriceDelete {
"""A shipping method to delete."""
shippingMethod: ShippingMethodType
@@ -21132,7 +23179,7 @@ Deletes shipping prices.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingPriceBulkDelete @doc(category: "Shipping") {
+type ShippingPriceBulkDelete {
"""Returns how many objects were affected."""
count: Int!
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -21144,7 +23191,7 @@ Updates a new shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingPriceUpdate @doc(category: "Shipping") {
+type ShippingPriceUpdate {
"""A shipping zone to which the shipping method belongs."""
shippingZone: ShippingZone
shippingMethod: ShippingMethodType
@@ -21157,7 +23204,7 @@ Creates/updates translations for a shipping method.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type ShippingPriceTranslate @doc(category: "Shipping") {
+type ShippingPriceTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
shippingMethod: ShippingMethodType
@@ -21179,14 +23226,14 @@ Exclude products from shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingPriceExcludeProducts @doc(category: "Shipping") {
+type ShippingPriceExcludeProducts {
"""A shipping method with new list of excluded products."""
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShippingError!]!
}
-input ShippingPriceExcludeProductsInput @doc(category: "Shipping") {
+input ShippingPriceExcludeProductsInput {
"""List of products which will be excluded."""
products: [ID!]!
}
@@ -21196,7 +23243,7 @@ Remove product from excluded list for shipping price.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingPriceRemoveProductFromExclude @doc(category: "Shipping") {
+type ShippingPriceRemoveProductFromExclude {
"""A shipping method with new list of excluded products."""
shippingMethod: ShippingMethodType
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -21208,13 +23255,13 @@ Creates a new shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingZoneCreate @doc(category: "Shipping") {
+type ShippingZoneCreate {
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShippingError!]!
shippingZone: ShippingZone
}
-input ShippingZoneCreateInput @doc(category: "Shipping") {
+input ShippingZoneCreateInput {
"""Shipping zone's name. Visible only to the staff."""
name: String
@@ -21241,7 +23288,7 @@ Deletes a shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingZoneDelete @doc(category: "Shipping") {
+type ShippingZoneDelete {
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShippingError!]!
shippingZone: ShippingZone
@@ -21252,7 +23299,7 @@ Deletes shipping zones.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingZoneBulkDelete @doc(category: "Shipping") {
+type ShippingZoneBulkDelete {
"""Returns how many objects were affected."""
count: Int!
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -21264,13 +23311,13 @@ Updates a new shipping zone.
Requires one of the following permissions: MANAGE_SHIPPING.
"""
-type ShippingZoneUpdate @doc(category: "Shipping") {
+type ShippingZoneUpdate {
shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ShippingError!]!
shippingZone: ShippingZone
}
-input ShippingZoneUpdateInput @doc(category: "Shipping") {
+input ShippingZoneUpdateInput {
"""Shipping zone's name. Visible only to the staff."""
name: String
@@ -21303,14 +23350,14 @@ Assign attributes to a given product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductAttributeAssign @doc(category: "Products") {
+type ProductAttributeAssign {
"""The updated product type."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
}
-type ProductError @doc(category: "Products") {
+type ProductError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -21329,7 +23376,7 @@ type ProductError @doc(category: "Products") {
values: [ID!]
}
-enum ProductErrorCode @doc(category: "Products") {
+enum ProductErrorCode {
ALREADY_EXISTS
ATTRIBUTE_ALREADY_ASSIGNED
ATTRIBUTE_CANNOT_BE_ASSIGNED
@@ -21350,9 +23397,11 @@ enum ProductErrorCode @doc(category: "Products") {
PRODUCT_NOT_ASSIGNED_TO_CHANNEL
UNSUPPORTED_MEDIA_PROVIDER
PREORDER_VARIANT_CANNOT_BE_DEACTIVATED
+ INVALID_FILE_TYPE
+ UNSUPPORTED_MIME_TYPE
}
-input ProductAttributeAssignInput @doc(category: "Products") {
+input ProductAttributeAssignInput {
"""The ID of the attribute to assign."""
id: ID!
@@ -21365,7 +23414,7 @@ input ProductAttributeAssignInput @doc(category: "Products") {
variantSelection: Boolean
}
-enum ProductAttributeType @doc(category: "Products") {
+enum ProductAttributeType {
PRODUCT
VARIANT
}
@@ -21375,14 +23424,14 @@ Update attributes assigned to product variant for given product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductAttributeAssignmentUpdate @doc(category: "Products") {
+type ProductAttributeAssignmentUpdate {
"""The updated product type."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
}
-input ProductAttributeAssignmentUpdateInput @doc(category: "Products") {
+input ProductAttributeAssignmentUpdateInput {
"""The ID of the attribute to assign."""
id: ID!
@@ -21397,7 +23446,7 @@ Un-assign attributes from a given product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductAttributeUnassign @doc(category: "Products") {
+type ProductAttributeUnassign {
"""The updated product type."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -21409,13 +23458,13 @@ Creates a new category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CategoryCreate @doc(category: "Products") {
+type CategoryCreate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
category: Category
}
-input CategoryInput @doc(category: "Products") {
+input CategoryInput {
"""
Category description.
@@ -21471,7 +23520,7 @@ Deletes a category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CategoryDelete @doc(category: "Products") {
+type CategoryDelete {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
category: Category
@@ -21482,7 +23531,7 @@ Deletes categories.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CategoryBulkDelete @doc(category: "Products") {
+type CategoryBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -21494,7 +23543,7 @@ Updates a category.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CategoryUpdate @doc(category: "Products") {
+type CategoryUpdate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
category: Category
@@ -21505,7 +23554,7 @@ Creates/updates translations for a category.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type CategoryTranslate @doc(category: "Products") {
+type CategoryTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
category: Category
@@ -21530,14 +23579,14 @@ Adds products to a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionAddProducts @doc(category: "Products") {
+type CollectionAddProducts {
"""Collection to which products will be added."""
collection: Collection
collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CollectionError!]!
}
-type CollectionError @doc(category: "Products") {
+type CollectionError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -21553,7 +23602,7 @@ type CollectionError @doc(category: "Products") {
code: CollectionErrorCode!
}
-enum CollectionErrorCode @doc(category: "Products") {
+enum CollectionErrorCode {
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
INVALID
@@ -21568,13 +23617,13 @@ Creates a new collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionCreate @doc(category: "Products") {
+type CollectionCreate {
collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CollectionError!]!
collection: Collection
}
-input CollectionCreateInput @doc(category: "Products") {
+input CollectionCreateInput {
"""Informs whether a collection is published."""
isPublished: Boolean
@@ -21600,8 +23649,12 @@ input CollectionCreateInput @doc(category: "Products") {
"""Search engine optimization fields."""
seo: SeoInput
- """Publication date. ISO 8601 standard."""
- publicationDate: Date @deprecated
+ """
+ Publication date. ISO 8601 standard.
+
+ DEPRECATED: this field will be removed.
+ """
+ publicationDate: Date
"""
Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to.
@@ -21626,7 +23679,7 @@ Deletes a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionDelete @doc(category: "Products") {
+type CollectionDelete {
collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CollectionError!]!
collection: Collection
@@ -21637,14 +23690,14 @@ Reorder the products of a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionReorderProducts @doc(category: "Products") {
+type CollectionReorderProducts {
"""Collection from which products are reordered."""
collection: Collection
collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CollectionError!]!
}
-input MoveProductInput @doc(category: "Products") {
+input MoveProductInput {
"""The ID of the product to move."""
productId: ID!
@@ -21659,7 +23712,7 @@ Deletes collections.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionBulkDelete @doc(category: "Products") {
+type CollectionBulkDelete {
"""Returns how many objects were affected."""
count: Int!
collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -21671,7 +23724,7 @@ Remove products from a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionRemoveProducts @doc(category: "Products") {
+type CollectionRemoveProducts {
"""Collection from which products will be removed."""
collection: Collection
collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -21683,13 +23736,13 @@ Updates a collection.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionUpdate @doc(category: "Products") {
+type CollectionUpdate {
collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CollectionError!]!
collection: Collection
}
-input CollectionInput @doc(category: "Products") {
+input CollectionInput {
"""Informs whether a collection is published."""
isPublished: Boolean
@@ -21715,8 +23768,12 @@ input CollectionInput @doc(category: "Products") {
"""Search engine optimization fields."""
seo: SeoInput
- """Publication date. ISO 8601 standard."""
- publicationDate: Date @deprecated
+ """
+ Publication date. ISO 8601 standard.
+
+ DEPRECATED: this field will be removed.
+ """
+ publicationDate: Date
"""
Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to.
@@ -21738,7 +23795,7 @@ Creates/updates translations for a collection.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type CollectionTranslate @doc(category: "Products") {
+type CollectionTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
collection: Collection
@@ -21749,14 +23806,14 @@ Manage collection's availability in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type CollectionChannelListingUpdate @doc(category: "Products") {
+type CollectionChannelListingUpdate {
"""An updated collection instance."""
collection: Collection
collectionChannelListingErrors: [CollectionChannelListingError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CollectionChannelListingError!]!
}
-type CollectionChannelListingError @doc(category: "Products") {
+type CollectionChannelListingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -21778,7 +23835,7 @@ type CollectionChannelListingError @doc(category: "Products") {
channels: [ID!]
}
-input CollectionChannelListingUpdateInput @doc(category: "Products") {
+input CollectionChannelListingUpdateInput {
"""List of channels to which the collection should be assigned."""
addChannels: [PublishableChannelListingInput!]
@@ -21786,15 +23843,19 @@ input CollectionChannelListingUpdateInput @doc(category: "Products") {
removeChannels: [ID!]
}
-input PublishableChannelListingInput @doc(category: "Products") {
+input PublishableChannelListingInput {
"""ID of a channel."""
channelId: ID!
"""Determines if object is visible to customers."""
isPublished: Boolean
- """Publication date. ISO 8601 standard."""
- publicationDate: Date @deprecated(reason: "Use `publishedAt` field instead.")
+ """
+ Publication date. ISO 8601 standard.
+
+ DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ """
+ publicationDate: Date
"""Publication date time. ISO 8601 standard."""
publishedAt: DateTime
@@ -21805,21 +23866,25 @@ Creates a new product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductCreate @doc(category: "Products") {
+type ProductCreate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
product: Product
}
-input ProductCreateInput @doc(category: "Products") {
+input ProductCreateInput {
"""List of attributes."""
attributes: [AttributeValueInput!]
"""ID of the product's category."""
category: ID
- """Determine if taxes are being charged for the product."""
- chargeTaxes: Boolean @deprecated(reason: "Use `Channel.taxConfiguration` to configure whether tax collection is enabled.")
+ """
+ Determine if taxes are being charged for the product.
+
+ DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ """
+ chargeTaxes: Boolean
"""List of IDs of collections that the product belongs to."""
collections: [ID!]
@@ -21842,8 +23907,12 @@ input ProductCreateInput @doc(category: "Products") {
"""
taxClass: ID
- """Tax rate for enabled tax gateway."""
- taxCode: String @deprecated(reason: "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.")
+ """
+ Tax rate for enabled tax gateway.
+
+ DEPRECATED: this field will be removed. 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
@@ -21875,7 +23944,7 @@ input ProductCreateInput @doc(category: "Products") {
productType: ID!
}
-input AttributeValueInput @doc(category: "Attributes") {
+input AttributeValueInput {
"""ID of the selected attribute."""
id: ID
@@ -21883,9 +23952,11 @@ input AttributeValueInput @doc(category: "Attributes") {
externalReference: String
"""
- The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
+ The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
+
+ DEPRECATED: this field will be removed.
"""
- values: [String!] @deprecated
+ values: [String!]
"""Attribute value ID or external reference."""
dropdown: AttributeValueSelectableTypeInput
@@ -21938,7 +24009,7 @@ Represents attribute value.
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.
"""
-input AttributeValueSelectableTypeInput @doc(category: "Attributes") {
+input AttributeValueSelectableTypeInput {
"""ID of an attribute value."""
id: ID
@@ -21956,7 +24027,7 @@ Deletes a product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductDelete @doc(category: "Products") {
+type ProductDelete {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
product: Product
@@ -21967,7 +24038,7 @@ Creates products.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductBulkCreate @doc(category: "Products") {
+type ProductBulkCreate {
"""Returns how many objects were created."""
count: Int!
@@ -21976,7 +24047,7 @@ type ProductBulkCreate @doc(category: "Products") {
errors: [ProductBulkCreateError!]!
}
-type ProductBulkResult @doc(category: "Products") {
+type ProductBulkResult {
"""Product data."""
product: Product
@@ -21984,7 +24055,7 @@ type ProductBulkResult @doc(category: "Products") {
errors: [ProductBulkCreateError!]
}
-type ProductBulkCreateError @doc(category: "Products") {
+type ProductBulkCreateError {
"""
Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -22009,7 +24080,7 @@ type ProductBulkCreateError @doc(category: "Products") {
channels: [ID!]
}
-enum ProductBulkCreateErrorCode @doc(category: "Products") {
+enum ProductBulkCreateErrorCode {
ATTRIBUTE_ALREADY_ASSIGNED
ATTRIBUTE_CANNOT_BE_ASSIGNED
ATTRIBUTE_VARIANTS_DISABLED
@@ -22027,15 +24098,19 @@ enum ProductBulkCreateErrorCode @doc(category: "Products") {
UNSUPPORTED_MEDIA_PROVIDER
}
-input ProductBulkCreateInput @doc(category: "Products") {
+input ProductBulkCreateInput {
"""List of attributes."""
attributes: [AttributeValueInput!]
"""ID of the product's category."""
category: ID
- """Determine if taxes are being charged for the product."""
- chargeTaxes: Boolean @deprecated(reason: "Use `Channel.taxConfiguration` to configure whether tax collection is enabled.")
+ """
+ Determine if taxes are being charged for the product.
+
+ DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ """
+ chargeTaxes: Boolean
"""List of IDs of collections that the product belongs to."""
collections: [ID!]
@@ -22058,8 +24133,12 @@ input ProductBulkCreateInput @doc(category: "Products") {
"""
taxClass: ID
- """Tax rate for enabled tax gateway."""
- taxCode: String @deprecated(reason: "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.")
+ """
+ Tax rate for enabled tax gateway.
+
+ DEPRECATED: this field will be removed. 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
@@ -22111,7 +24190,7 @@ input MediaInput {
mediaUrl: String
}
-input ProductChannelListingCreateInput @doc(category: "Products") {
+input ProductChannelListingCreateInput {
"""ID of a channel."""
channelId: ID!
@@ -22137,7 +24216,7 @@ input ProductChannelListingCreateInput @doc(category: "Products") {
availableForPurchaseAt: DateTime
}
-input ProductVariantBulkCreateInput @doc(category: "Products") {
+input ProductVariantBulkCreateInput {
"""List of attributes specific to this variant."""
attributes: [BulkAttributeValueInput!]!
@@ -22187,7 +24266,7 @@ input ProductVariantBulkCreateInput @doc(category: "Products") {
channelListings: [ProductVariantChannelListingAddInput!]
}
-input BulkAttributeValueInput @doc(category: "Products") {
+input BulkAttributeValueInput {
"""ID of the selected attribute."""
id: ID
@@ -22196,8 +24275,10 @@ input BulkAttributeValueInput @doc(category: "Products") {
"""
The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
+
+ DEPRECATED: this field will be removed.
"""
- values: [String!] @deprecated
+ values: [String!]
"""Attribute value ID."""
dropdown: AttributeValueSelectableTypeInput
@@ -22245,7 +24326,7 @@ input BulkAttributeValueInput @doc(category: "Products") {
dateTime: DateTime
}
-input PreorderSettingsInput @doc(category: "Products") {
+input PreorderSettingsInput {
"""The global threshold for preorder variant."""
globalThreshold: Int
@@ -22253,7 +24334,7 @@ input PreorderSettingsInput @doc(category: "Products") {
endDate: DateTime
}
-input StockInput @doc(category: "Products") {
+input StockInput {
"""Warehouse in which stock is located."""
warehouse: ID!
@@ -22261,7 +24342,7 @@ input StockInput @doc(category: "Products") {
quantity: Int!
}
-input ProductVariantChannelListingAddInput @doc(category: "Products") {
+input ProductVariantChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
@@ -22287,7 +24368,7 @@ Deletes products.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductBulkDelete @doc(category: "Products") {
+type ProductBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -22299,21 +24380,25 @@ Updates an existing product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductUpdate @doc(category: "Products") {
+type ProductUpdate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
product: Product
}
-input ProductInput @doc(category: "Products") {
+input ProductInput {
"""List of attributes."""
attributes: [AttributeValueInput!]
"""ID of the product's category."""
category: ID
- """Determine if taxes are being charged for the product."""
- chargeTaxes: Boolean @deprecated(reason: "Use `Channel.taxConfiguration` to configure whether tax collection is enabled.")
+ """
+ Determine if taxes are being charged for the product.
+
+ DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ """
+ chargeTaxes: Boolean
"""List of IDs of collections that the product belongs to."""
collections: [ID!]
@@ -22336,8 +24421,12 @@ input ProductInput @doc(category: "Products") {
"""
taxClass: ID
- """Tax rate for enabled tax gateway."""
- taxCode: String @deprecated(reason: "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.")
+ """
+ Tax rate for enabled tax gateway.
+
+ DEPRECATED: this field will be removed. 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
@@ -22375,7 +24464,7 @@ Triggers the following webhook events:
- TRANSLATION_CREATED (async): Called when a translation was created.
- TRANSLATION_UPDATED (async): Called when a translation was updated.
"""
-type ProductBulkTranslate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [TRANSLATION_CREATED, TRANSLATION_UPDATED], syncEvents: []) {
+type ProductBulkTranslate {
"""Returns how many translations were created/updated."""
count: Int!
@@ -22384,7 +24473,7 @@ type ProductBulkTranslate @doc(category: "Products") @webhookEventsInfo(asyncEve
errors: [ProductBulkTranslateError!]!
}
-type ProductBulkTranslateResult @doc(category: "Products") {
+type ProductBulkTranslateResult {
"""Product translation data."""
translation: ProductTranslation
@@ -22405,14 +24494,14 @@ type ProductBulkTranslateError {
code: ProductTranslateErrorCode!
}
-enum ProductTranslateErrorCode @doc(category: "Products") {
+enum ProductTranslateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
}
-input ProductBulkTranslateInput @doc(category: "Products") {
+input ProductBulkTranslateInput {
"""Product ID."""
id: ID
@@ -22431,7 +24520,7 @@ Creates/updates translations for a product.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type ProductTranslate @doc(category: "Products") {
+type ProductTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
product: Product
@@ -22442,14 +24531,14 @@ Manage product's availability in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductChannelListingUpdate @doc(category: "Products") {
+type ProductChannelListingUpdate {
"""An updated product instance."""
product: Product
productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductChannelListingError!]!
}
-type ProductChannelListingError @doc(category: "Products") {
+type ProductChannelListingError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -22474,7 +24563,7 @@ type ProductChannelListingError @doc(category: "Products") {
variants: [ID!]
}
-input ProductChannelListingUpdateInput @doc(category: "Products") {
+input ProductChannelListingUpdateInput {
"""List of channels to which the product should be assigned or updated."""
updateChannels: [ProductChannelListingAddInput!]
@@ -22482,15 +24571,19 @@ input ProductChannelListingUpdateInput @doc(category: "Products") {
removeChannels: [ID!]
}
-input ProductChannelListingAddInput @doc(category: "Products") {
+input ProductChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
"""Determines if object is visible to customers."""
isPublished: Boolean
- """Publication date. ISO 8601 standard."""
- publicationDate: Date @deprecated(reason: "Use `publishedAt` field instead.")
+ """
+ Publication date. ISO 8601 standard.
+
+ DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ """
+ publicationDate: Date
"""Publication date time. ISO 8601 standard."""
publishedAt: DateTime
@@ -22506,9 +24599,11 @@ input ProductChannelListingAddInput @doc(category: "Products") {
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.
+ 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. Use `availableForPurchaseAt` field instead.
"""
- availableForPurchaseDate: Date @deprecated(reason: "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.
@@ -22527,14 +24622,14 @@ Create a media object (image or video URL) associated with product. For image, t
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductMediaCreate @doc(category: "Products") {
+type ProductMediaCreate {
product: Product
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
}
-input ProductMediaCreateInput @doc(category: "Products") {
+input ProductMediaCreateInput {
"""Alt text for a product media."""
alt: String
@@ -22553,7 +24648,7 @@ Reorder the variants of a product. Mutation updates updated_at on product and tr
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantReorder @doc(category: "Products") {
+type ProductVariantReorder {
product: Product
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
@@ -22574,7 +24669,7 @@ Deletes a product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductMediaDelete @doc(category: "Products") {
+type ProductMediaDelete {
product: Product
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -22586,7 +24681,7 @@ Deletes product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductMediaBulkDelete @doc(category: "Products") {
+type ProductMediaBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -22598,7 +24693,7 @@ Changes ordering of the product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductMediaReorder @doc(category: "Products") {
+type ProductMediaReorder {
product: Product
media: [ProductMedia!]
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -22610,14 +24705,14 @@ Updates a product media.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductMediaUpdate @doc(category: "Products") {
+type ProductMediaUpdate {
product: Product
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
}
-input ProductMediaUpdateInput @doc(category: "Products") {
+input ProductMediaUpdateInput {
"""Alt text for a product media."""
alt: String
}
@@ -22627,13 +24722,13 @@ Creates a new product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductTypeCreate @doc(category: "Products") {
+type ProductTypeCreate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
productType: ProductType
}
-input ProductTypeInput @doc(category: "Products") {
+input ProductTypeInput {
"""Name of the product type."""
name: String
@@ -22665,8 +24760,12 @@ input ProductTypeInput @doc(category: "Products") {
"""Weight of the ProductType items."""
weight: WeightScalar
- """Tax rate for enabled tax gateway."""
- taxCode: String @deprecated(reason: "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.")
+ """
+ Tax rate for enabled tax gateway.
+
+ DEPRECATED: this field will be removed. 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.
@@ -22679,7 +24778,7 @@ Deletes a product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductTypeDelete @doc(category: "Products") {
+type ProductTypeDelete {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
productType: ProductType
@@ -22690,7 +24789,7 @@ Deletes product types.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductTypeBulkDelete @doc(category: "Products") {
+type ProductTypeBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -22702,7 +24801,7 @@ Updates an existing product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductTypeUpdate @doc(category: "Products") {
+type ProductTypeUpdate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
productType: ProductType
@@ -22713,7 +24812,7 @@ Reorder the attributes of a product type.
Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
"""
-type ProductTypeReorderAttributes @doc(category: "Products") {
+type ProductTypeReorderAttributes {
"""Product type from which attributes are reordered."""
productType: ProductType
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -22725,7 +24824,7 @@ Reorder product attribute values.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductReorderAttributeValues @doc(category: "Products") {
+type ProductReorderAttributeValues {
"""Product from which attribute values are reordered."""
product: Product
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -22737,14 +24836,14 @@ Create new digital content. This mutation must be sent as a `multipart` request.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type DigitalContentCreate @doc(category: "Products") {
+type DigitalContentCreate {
variant: ProductVariant
content: DigitalContent
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
}
-input DigitalContentUploadInput @doc(category: "Products") {
+input DigitalContentUploadInput {
"""Use default digital content settings for this product."""
useDefaultSettings: Boolean!
@@ -22784,7 +24883,7 @@ Remove digital content assigned to given variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type DigitalContentDelete @doc(category: "Products") {
+type DigitalContentDelete {
variant: ProductVariant
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
@@ -22795,14 +24894,14 @@ Updates digital content.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type DigitalContentUpdate @doc(category: "Products") {
+type DigitalContentUpdate {
variant: ProductVariant
content: DigitalContent
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
}
-input DigitalContentInput @doc(category: "Products") {
+input DigitalContentInput {
"""Use default digital content settings for this product."""
useDefaultSettings: Boolean!
@@ -22839,13 +24938,13 @@ Generate new URL to digital content.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type DigitalContentUrlCreate @doc(category: "Products") {
+type DigitalContentUrlCreate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
digitalContentUrl: DigitalContentUrl
}
-input DigitalContentUrlCreateInput @doc(category: "Products") {
+input DigitalContentUrlCreateInput {
"""Digital content ID which URL will belong to."""
content: ID!
}
@@ -22855,13 +24954,13 @@ Creates a new variant for a product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantCreate @doc(category: "Products") {
+type ProductVariantCreate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
productVariant: ProductVariant
}
-input ProductVariantCreateInput @doc(category: "Products") {
+input ProductVariantCreateInput {
"""List of attributes specific to this variant."""
attributes: [AttributeValueInput!]!
@@ -22916,7 +25015,7 @@ Deletes a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantDelete @doc(category: "Products") {
+type ProductVariantDelete {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
productVariant: ProductVariant
@@ -22927,11 +25026,15 @@ Creates product variants for a given product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantBulkCreate @doc(category: "Products") {
+type ProductVariantBulkCreate {
"""Returns how many objects were created."""
count: Int!
- """List of the created variants."""
+ """
+ List of the created variants.
+
+ DEPRECATED: this field will be removed.
+ """
productVariants: [ProductVariant!]!
"""List of the created variants."""
@@ -22940,7 +25043,7 @@ type ProductVariantBulkCreate @doc(category: "Products") {
errors: [BulkProductError!]!
}
-type ProductVariantBulkResult @doc(category: "Products") {
+type ProductVariantBulkResult {
"""Product variant data."""
productVariant: ProductVariant
@@ -22948,7 +25051,7 @@ type ProductVariantBulkResult @doc(category: "Products") {
errors: [ProductVariantBulkError!]
}
-type ProductVariantBulkError @doc(category: "Products") {
+type ProductVariantBulkError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -22984,7 +25087,7 @@ type ProductVariantBulkError @doc(category: "Products") {
channelListings: [ID!]
}
-enum ProductVariantBulkErrorCode @doc(category: "Products") {
+enum ProductVariantBulkErrorCode {
ATTRIBUTE_ALREADY_ASSIGNED
ATTRIBUTE_CANNOT_BE_ASSIGNED
ATTRIBUTE_VARIANTS_DISABLED
@@ -23000,7 +25103,7 @@ enum ProductVariantBulkErrorCode @doc(category: "Products") {
STOCK_ALREADY_EXISTS
}
-type BulkProductError @doc(category: "Products") {
+type BulkProductError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23033,7 +25136,7 @@ Updates multiple product variants.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantBulkUpdate @doc(category: "Products") {
+type ProductVariantBulkUpdate {
"""Returns how many objects were updated."""
count: Int!
@@ -23043,7 +25146,7 @@ type ProductVariantBulkUpdate @doc(category: "Products") {
}
"""Input fields to update product variants."""
-input ProductVariantBulkUpdateInput @doc(category: "Products") {
+input ProductVariantBulkUpdateInput {
"""List of attributes specific to this variant."""
attributes: [BulkAttributeValueInput!]
@@ -23096,7 +25199,7 @@ input ProductVariantBulkUpdateInput @doc(category: "Products") {
id: ID!
}
-input ProductVariantStocksUpdateInput @doc(category: "Products") {
+input ProductVariantStocksUpdateInput {
"""List of warehouses to create stocks."""
create: [StockInput!]
@@ -23107,7 +25210,7 @@ input ProductVariantStocksUpdateInput @doc(category: "Products") {
remove: [ID!]
}
-input StockUpdateInput @doc(category: "Products") {
+input StockUpdateInput {
"""Stock."""
stock: ID!
@@ -23115,7 +25218,7 @@ input StockUpdateInput @doc(category: "Products") {
quantity: Int!
}
-input ProductVariantChannelListingUpdateInput @doc(category: "Products") {
+input ProductVariantChannelListingUpdateInput {
"""List of channels to create variant channel listings."""
create: [ProductVariantChannelListingAddInput!]
@@ -23126,7 +25229,7 @@ input ProductVariantChannelListingUpdateInput @doc(category: "Products") {
remove: [ID!]
}
-input ChannelListingUpdateInput @doc(category: "Products") {
+input ChannelListingUpdateInput {
"""ID of a channel listing."""
channelListing: ID!
@@ -23148,7 +25251,7 @@ Deletes product variants.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantBulkDelete @doc(category: "Products") {
+type ProductVariantBulkDelete {
"""Returns how many objects were affected."""
count: Int!
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23160,14 +25263,14 @@ Creates stocks for product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantStocksCreate @doc(category: "Products") {
+type ProductVariantStocksCreate {
"""Updated product variant."""
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [BulkStockError!]!
}
-type BulkStockError @doc(category: "Products") {
+type BulkStockError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23194,14 +25297,14 @@ Deletes stocks from product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantStocksDelete @doc(category: "Products") {
+type ProductVariantStocksDelete {
"""Updated product variant."""
productVariant: ProductVariant
stockErrors: [StockError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [StockError!]!
}
-type StockError @doc(category: "Products") {
+type StockError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23214,7 +25317,7 @@ type StockError @doc(category: "Products") {
code: StockErrorCode!
}
-enum StockErrorCode @doc(category: "Products") {
+enum StockErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
@@ -23228,7 +25331,7 @@ Updates stocks for product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantStocksUpdate @doc(category: "Products") {
+type ProductVariantStocksUpdate {
"""Updated product variant."""
productVariant: ProductVariant
bulkStockErrors: [BulkStockError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23240,13 +25343,13 @@ Updates an existing variant for product.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantUpdate @doc(category: "Products") {
+type ProductVariantUpdate {
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
productVariant: ProductVariant
}
-input ProductVariantInput @doc(category: "Products") {
+input ProductVariantInput {
"""List of attributes specific to this variant."""
attributes: [AttributeValueInput!]
@@ -23295,7 +25398,7 @@ Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantSetDefault @doc(category: "Products") {
+type ProductVariantSetDefault {
product: Product
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ProductError!]!
@@ -23306,7 +25409,7 @@ Creates/updates translations for a product variant.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type ProductVariantTranslate @doc(category: "Products") {
+type ProductVariantTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
productVariant: ProductVariant
@@ -23325,7 +25428,7 @@ Triggers the following webhook events:
- TRANSLATION_CREATED (async): A translation was created.
- TRANSLATION_UPDATED (async): A translation was updated.
"""
-type ProductVariantBulkTranslate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [TRANSLATION_CREATED, TRANSLATION_UPDATED], syncEvents: []) {
+type ProductVariantBulkTranslate {
"""Returns how many translations were created/updated."""
count: Int!
@@ -23334,7 +25437,7 @@ type ProductVariantBulkTranslate @doc(category: "Products") @webhookEventsInfo(a
errors: [ProductVariantBulkTranslateError!]!
}
-type ProductVariantBulkTranslateResult @doc(category: "Products") {
+type ProductVariantBulkTranslateResult {
"""Product variant translation data."""
translation: ProductVariantTranslation
@@ -23355,14 +25458,14 @@ type ProductVariantBulkTranslateError {
code: ProductVariantTranslateErrorCode!
}
-enum ProductVariantTranslateErrorCode @doc(category: "Products") {
+enum ProductVariantTranslateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
}
-input ProductVariantBulkTranslateInput @doc(category: "Products") {
+input ProductVariantBulkTranslateInput {
"""Product variant ID."""
id: ID
@@ -23381,7 +25484,7 @@ Manage product variant prices in channels.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantChannelListingUpdate @doc(category: "Products") {
+type ProductVariantChannelListingUpdate {
"""An updated product variant instance."""
variant: ProductVariant
productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23393,7 +25496,7 @@ Reorder product variant attribute values.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantReorderAttributeValues @doc(category: "Products") {
+type ProductVariantReorderAttributeValues {
"""Product variant from which attribute values are reordered."""
productVariant: ProductVariant
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23405,7 +25508,7 @@ Deactivates product variant preorder. It changes all preorder allocation into re
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type ProductVariantPreorderDeactivate @doc(category: "Products") {
+type ProductVariantPreorderDeactivate {
"""Product variant with ended preorder."""
productVariant: ProductVariant
errors: [ProductError!]!
@@ -23416,7 +25519,7 @@ Assign an media to a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type VariantMediaAssign @doc(category: "Products") {
+type VariantMediaAssign {
productVariant: ProductVariant
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23428,7 +25531,7 @@ Unassign an media from a product variant.
Requires one of the following permissions: MANAGE_PRODUCTS.
"""
-type VariantMediaUnassign @doc(category: "Products") {
+type VariantMediaUnassign {
productVariant: ProductVariant
media: ProductMedia
productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23440,14 +25543,14 @@ Captures the authorized payment amount.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type PaymentCapture @doc(category: "Payments") {
+type PaymentCapture {
"""Updated payment."""
payment: Payment
paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PaymentError!]!
}
-type PaymentError @doc(category: "Payments") {
+type PaymentError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23463,7 +25566,7 @@ type PaymentError @doc(category: "Payments") {
variants: [ID!]
}
-enum PaymentErrorCode @doc(category: "Payments") {
+enum PaymentErrorCode {
BILLING_ADDRESS_NOT_SET
GRAPHQL_ERROR
INVALID
@@ -23490,7 +25593,7 @@ Refunds the captured payment amount.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type PaymentRefund @doc(category: "Payments") {
+type PaymentRefund {
"""Updated payment."""
payment: Payment
paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23502,7 +25605,7 @@ Voids the authorized payment.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type PaymentVoid @doc(category: "Payments") {
+type PaymentVoid {
"""Updated payment."""
payment: Payment
paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23510,7 +25613,7 @@ type PaymentVoid @doc(category: "Payments") {
}
"""Initializes payment process when it is required by gateway."""
-type PaymentInitialize @doc(category: "Payments") {
+type PaymentInitialize {
"""Payment that was initialized."""
initializedPayment: PaymentInitialized
paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -23520,7 +25623,7 @@ type PaymentInitialize @doc(category: "Payments") {
"""
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") {
+type PaymentInitialized {
"""ID of a payment gateway."""
gateway: String!
@@ -23532,14 +25635,14 @@ type PaymentInitialized @doc(category: "Payments") {
}
"""Check payment balance."""
-type PaymentCheckBalance @doc(category: "Payments") {
+type PaymentCheckBalance {
"""Response from the gateway."""
data: JSONString
paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PaymentError!]!
}
-input PaymentCheckBalanceInput @doc(category: "Payments") {
+input PaymentCheckBalanceInput {
"""An ID of a payment gateway to check."""
gatewayId: String!
@@ -23579,12 +25682,12 @@ Creates transaction for checkout or order.
Requires one of the following permissions: HANDLE_PAYMENTS.
"""
-type TransactionCreate @doc(category: "Payments") {
+type TransactionCreate {
transaction: TransactionItem
errors: [TransactionCreateError!]!
}
-type TransactionCreateError @doc(category: "Payments") {
+type TransactionCreateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23597,7 +25700,7 @@ type TransactionCreateError @doc(category: "Payments") {
code: TransactionCreateErrorCode!
}
-enum TransactionCreateErrorCode @doc(category: "Payments") {
+enum TransactionCreateErrorCode {
INVALID
GRAPHQL_ERROR
NOT_FOUND
@@ -23606,7 +25709,7 @@ enum TransactionCreateErrorCode @doc(category: "Payments") {
UNIQUE
}
-input TransactionCreateInput @doc(category: "Payments") {
+input TransactionCreateInput {
"""Payment name of the transaction."""
name: String
@@ -23708,7 +25811,7 @@ input OtherPaymentMethodDetailsInput {
name: String!
}
-input TransactionEventInput @doc(category: "Payments") {
+input TransactionEventInput {
"""PSP Reference related to this action."""
pspReference: String
@@ -23721,12 +25824,12 @@ Update transaction.
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") {
+type TransactionUpdate {
transaction: TransactionItem
errors: [TransactionUpdateError!]!
}
-type TransactionUpdateError @doc(category: "Payments") {
+type TransactionUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23739,7 +25842,7 @@ type TransactionUpdateError @doc(category: "Payments") {
code: TransactionUpdateErrorCode!
}
-enum TransactionUpdateErrorCode @doc(category: "Payments") {
+enum TransactionUpdateErrorCode {
INVALID
GRAPHQL_ERROR
NOT_FOUND
@@ -23748,7 +25851,7 @@ enum TransactionUpdateErrorCode @doc(category: "Payments") {
UNIQUE
}
-input TransactionUpdateInput @doc(category: "Payments") {
+input TransactionUpdateInput {
"""Payment name of the transaction."""
name: String
@@ -23805,12 +25908,12 @@ Request an action for payment transaction.
Requires one of the following permissions: HANDLE_PAYMENTS.
"""
-type TransactionRequestAction @doc(category: "Payments") {
+type TransactionRequestAction {
transaction: TransactionItem
errors: [TransactionRequestActionError!]!
}
-type TransactionRequestActionError @doc(category: "Payments") {
+type TransactionRequestActionError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23823,7 +25926,7 @@ type TransactionRequestActionError @doc(category: "Payments") {
code: TransactionRequestActionErrorCode!
}
-enum TransactionRequestActionErrorCode @doc(category: "Payments") {
+enum TransactionRequestActionErrorCode {
INVALID
REQUIRED
GRAPHQL_ERROR
@@ -23836,12 +25939,12 @@ Request a refund for payment transaction based on granted refund.
Requires one of the following permissions: HANDLE_PAYMENTS.
"""
-type TransactionRequestRefundForGrantedRefund @doc(category: "Payments") {
+type TransactionRequestRefundForGrantedRefund {
transaction: TransactionItem
errors: [TransactionRequestRefundForGrantedRefundError!]!
}
-type TransactionRequestRefundForGrantedRefundError @doc(category: "Payments") {
+type TransactionRequestRefundForGrantedRefundError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23854,7 +25957,7 @@ type TransactionRequestRefundForGrantedRefundError @doc(category: "Payments") {
code: TransactionRequestRefundForGrantedRefundErrorCode!
}
-enum TransactionRequestRefundForGrantedRefundErrorCode @doc(category: "Payments") {
+enum TransactionRequestRefundForGrantedRefundErrorCode {
INVALID
GRAPHQL_ERROR
NOT_FOUND
@@ -23874,7 +25977,7 @@ Triggers the following webhook events:
- CHECKOUT_FULLY_PAID (async): Optionally called when the checkout charge status changed to `FULL` or `OVERCHARGED`.
- ORDER_UPDATED (async): Optionally called when the transaction is related to the order and the order was updated.
"""
-type TransactionEventReport @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [TRANSACTION_ITEM_METADATA_UPDATED, CHECKOUT_FULLY_PAID, ORDER_UPDATED], syncEvents: []) {
+type TransactionEventReport {
"""Defines if the reported event hasn't been processed earlier."""
alreadyProcessed: Boolean
@@ -23888,7 +25991,7 @@ type TransactionEventReport @doc(category: "Payments") @webhookEventsInfo(asyncE
errors: [TransactionEventReportError!]!
}
-type TransactionEventReportError @doc(category: "Payments") {
+type TransactionEventReportError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23901,7 +26004,7 @@ type TransactionEventReportError @doc(category: "Payments") {
code: TransactionEventReportErrorCode!
}
-enum TransactionEventReportErrorCode @doc(category: "Payments") {
+enum TransactionEventReportErrorCode {
INVALID
GRAPHQL_ERROR
NOT_FOUND
@@ -23913,13 +26016,13 @@ enum TransactionEventReportErrorCode @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. There is a limit of 100 transaction items per checkout / order.
"""
-type PaymentGatewayInitialize @doc(category: "Payments") {
+type PaymentGatewayInitialize {
"""List of payment gateway configurations."""
gatewayConfigs: [PaymentGatewayConfig!]
errors: [PaymentGatewayInitializeError!]!
}
-type PaymentGatewayConfig @doc(category: "Payments") {
+type PaymentGatewayConfig {
"""The app identifier."""
id: String!
@@ -23928,7 +26031,7 @@ type PaymentGatewayConfig @doc(category: "Payments") {
errors: [PaymentGatewayConfigError!]
}
-type PaymentGatewayConfigError @doc(category: "Payments") {
+type PaymentGatewayConfigError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23941,13 +26044,13 @@ type PaymentGatewayConfigError @doc(category: "Payments") {
code: PaymentGatewayConfigErrorCode!
}
-enum PaymentGatewayConfigErrorCode @doc(category: "Payments") {
+enum PaymentGatewayConfigErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
-type PaymentGatewayInitializeError @doc(category: "Payments") {
+type PaymentGatewayInitializeError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -23960,13 +26063,13 @@ type PaymentGatewayInitializeError @doc(category: "Payments") {
code: PaymentGatewayInitializeErrorCode!
}
-enum PaymentGatewayInitializeErrorCode @doc(category: "Payments") {
+enum PaymentGatewayInitializeErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
}
-input PaymentGatewayToInitialize @doc(category: "Payments") {
+input PaymentGatewayToInitialize {
"""The identifier of the payment gateway app to initialize."""
id: String!
@@ -23977,7 +26080,7 @@ input PaymentGatewayToInitialize @doc(category: "Payments") {
"""
Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. There is a limit of 100 transaction items per checkout / order.
"""
-type TransactionInitialize @doc(category: "Payments") {
+type TransactionInitialize {
"""The initialized transaction."""
transaction: TransactionItem
@@ -23989,7 +26092,7 @@ type TransactionInitialize @doc(category: "Payments") {
errors: [TransactionInitializeError!]!
}
-type TransactionInitializeError @doc(category: "Payments") {
+type TransactionInitializeError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -24002,7 +26105,7 @@ type TransactionInitializeError @doc(category: "Payments") {
code: TransactionInitializeErrorCode!
}
-enum TransactionInitializeErrorCode @doc(category: "Payments") {
+enum TransactionInitializeErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -24011,9 +26114,9 @@ enum TransactionInitializeErrorCode @doc(category: "Payments") {
}
"""
-Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`.
+Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`.
"""
-type TransactionProcess @doc(category: "Payments") {
+type TransactionProcess {
"""The processed transaction."""
transaction: TransactionItem
@@ -24025,7 +26128,7 @@ type TransactionProcess @doc(category: "Payments") {
errors: [TransactionProcessError!]!
}
-type TransactionProcessError @doc(category: "Payments") {
+type TransactionProcessError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -24038,7 +26141,7 @@ type TransactionProcessError @doc(category: "Payments") {
code: TransactionProcessErrorCode!
}
-enum TransactionProcessErrorCode @doc(category: "Payments") {
+enum TransactionProcessErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -24056,28 +26159,20 @@ Requires one of the following permissions: AUTHENTICATED_USER.
Triggers the following webhook events:
- STORED_PAYMENT_METHOD_DELETE_REQUESTED (sync): The customer requested to delete a payment method.
"""
-type StoredPaymentMethodRequestDelete @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [STORED_PAYMENT_METHOD_DELETE_REQUESTED]) {
+type StoredPaymentMethodRequestDelete {
"""The result of deleting a stored payment method."""
result: StoredPaymentMethodRequestDeleteResult!
errors: [PaymentMethodRequestDeleteError!]!
}
-"""
-Result of deleting a stored payment method.
-
- This enum is used to determine the result of deleting a stored payment method.
- SUCCESSFULLY_DELETED - The stored payment method was successfully deleted.
- FAILED_TO_DELETE - The stored payment method was not deleted.
- FAILED_TO_DELIVER - The request to delete the stored payment method was not
- delivered.
-"""
-enum StoredPaymentMethodRequestDeleteResult @doc(category: "Payments") {
+"Result of deleting a stored payment method.\n\n This enum is used to determine the result of deleting a stored payment method.\n SUCCESSFULLY_DELETED - The stored payment method was successfully deleted.\n FAILED_TO_DELETE - The stored payment method was not deleted.\n FAILED_TO_DELIVER - The request to delete the stored payment method was not\n delivered.\n "
+enum StoredPaymentMethodRequestDeleteResult {
SUCCESSFULLY_DELETED
FAILED_TO_DELETE
FAILED_TO_DELIVER
}
-type PaymentMethodRequestDeleteError @doc(category: "Payments") {
+type PaymentMethodRequestDeleteError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -24090,7 +26185,7 @@ type PaymentMethodRequestDeleteError @doc(category: "Payments") {
code: StoredPaymentMethodRequestDeleteErrorCode!
}
-enum StoredPaymentMethodRequestDeleteErrorCode @doc(category: "Payments") {
+enum StoredPaymentMethodRequestDeleteErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -24106,7 +26201,7 @@ Requires one of the following permissions: AUTHENTICATED_USER.
Triggers the following webhook events:
- PAYMENT_GATEWAY_INITIALIZE_TOKENIZATION_SESSION (sync): The customer requested to initialize payment gateway for tokenization.
"""
-type PaymentGatewayInitializeTokenization @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_GATEWAY_INITIALIZE_TOKENIZATION_SESSION]) {
+type PaymentGatewayInitializeTokenization {
"""A status of the payment gateway initialization."""
result: PaymentGatewayInitializeTokenizationResult!
@@ -24115,21 +26210,14 @@ type PaymentGatewayInitializeTokenization @doc(category: "Payments") @webhookEve
errors: [PaymentGatewayInitializeTokenizationError!]!
}
-"""
-Result of initialize payment gateway for tokenization of payment method.
-
- The result of initialize payment gateway for tokenization of payment method.
- SUCCESSFULLY_INITIALIZED - The payment gateway was successfully initialized.
- FAILED_TO_INITIALIZE - The payment gateway was not initialized.
- FAILED_TO_DELIVER - The request to initialize payment gateway was not delivered.
-"""
-enum PaymentGatewayInitializeTokenizationResult @doc(category: "Payments") {
+"Result of initialize payment gateway for tokenization of payment method.\n\n The result of initialize payment gateway for tokenization of payment method.\n SUCCESSFULLY_INITIALIZED - The payment gateway was successfully initialized.\n FAILED_TO_INITIALIZE - The payment gateway was not initialized.\n FAILED_TO_DELIVER - The request to initialize payment gateway was not delivered.\n "
+enum PaymentGatewayInitializeTokenizationResult {
SUCCESSFULLY_INITIALIZED
FAILED_TO_INITIALIZE
FAILED_TO_DELIVER
}
-type PaymentGatewayInitializeTokenizationError @doc(category: "Payments") {
+type PaymentGatewayInitializeTokenizationError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -24142,7 +26230,7 @@ type PaymentGatewayInitializeTokenizationError @doc(category: "Payments") {
code: PaymentGatewayInitializeTokenizationErrorCode!
}
-enum PaymentGatewayInitializeTokenizationErrorCode @doc(category: "Payments") {
+enum PaymentGatewayInitializeTokenizationErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -24158,7 +26246,7 @@ Requires one of the following permissions: AUTHENTICATED_USER.
Triggers the following webhook events:
- PAYMENT_METHOD_INITIALIZE_TOKENIZATION_SESSION (sync): The customer requested to tokenize payment method.
"""
-type PaymentMethodInitializeTokenization @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_METHOD_INITIALIZE_TOKENIZATION_SESSION]) {
+type PaymentMethodInitializeTokenization {
"""A status of the payment method tokenization."""
result: PaymentMethodTokenizationResult!
@@ -24170,17 +26258,8 @@ type PaymentMethodInitializeTokenization @doc(category: "Payments") @webhookEven
errors: [PaymentMethodInitializeTokenizationError!]!
}
-"""
-Result of tokenization of payment method.
-
- SUCCESSFULLY_TOKENIZED - The payment method was successfully tokenized.
- ADDITIONAL_ACTION_REQUIRED - The additional action is required to tokenize payment
- method.
- PENDING - The payment method is pending tokenization.
- FAILED_TO_TOKENIZE - The payment method was not tokenized.
- FAILED_TO_DELIVER - The request to tokenize payment method was not delivered.
-"""
-enum PaymentMethodTokenizationResult @doc(category: "Payments") {
+"Result of tokenization of payment method.\n\n SUCCESSFULLY_TOKENIZED - The payment method was successfully tokenized.\n ADDITIONAL_ACTION_REQUIRED - The additional action is required to tokenize payment\n method.\n PENDING - The payment method is pending tokenization.\n FAILED_TO_TOKENIZE - The payment method was not tokenized.\n FAILED_TO_DELIVER - The request to tokenize payment method was not delivered.\n "
+enum PaymentMethodTokenizationResult {
SUCCESSFULLY_TOKENIZED
PENDING
ADDITIONAL_ACTION_REQUIRED
@@ -24188,7 +26267,7 @@ enum PaymentMethodTokenizationResult @doc(category: "Payments") {
FAILED_TO_DELIVER
}
-type PaymentMethodInitializeTokenizationError @doc(category: "Payments") {
+type PaymentMethodInitializeTokenizationError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -24201,7 +26280,7 @@ type PaymentMethodInitializeTokenizationError @doc(category: "Payments") {
code: PaymentMethodInitializeTokenizationErrorCode!
}
-enum PaymentMethodInitializeTokenizationErrorCode @doc(category: "Payments") {
+enum PaymentMethodInitializeTokenizationErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -24217,7 +26296,7 @@ Requires one of the following permissions: AUTHENTICATED_USER.
Triggers the following webhook events:
- PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION (sync): The customer continues payment method tokenization.
"""
-type PaymentMethodProcessTokenization @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION]) {
+type PaymentMethodProcessTokenization {
"""A status of the payment method tokenization."""
result: PaymentMethodTokenizationResult!
@@ -24229,7 +26308,7 @@ type PaymentMethodProcessTokenization @doc(category: "Payments") @webhookEventsI
errors: [PaymentMethodProcessTokenizationError!]!
}
-type PaymentMethodProcessTokenizationError @doc(category: "Payments") {
+type PaymentMethodProcessTokenizationError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -24242,7 +26321,7 @@ type PaymentMethodProcessTokenizationError @doc(category: "Payments") {
code: PaymentMethodProcessTokenizationErrorCode!
}
-enum PaymentMethodProcessTokenizationErrorCode @doc(category: "Payments") {
+enum PaymentMethodProcessTokenizationErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -24255,13 +26334,13 @@ Creates a new page.
Requires one of the following permissions: MANAGE_PAGES.
"""
-type PageCreate @doc(category: "Pages") {
+type PageCreate {
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PageError!]!
page: Page
}
-type PageError @doc(category: "Pages") {
+type PageError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -24280,7 +26359,7 @@ type PageError @doc(category: "Pages") {
values: [ID!]
}
-enum PageErrorCode @doc(category: "Pages") {
+enum PageErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
@@ -24290,7 +26369,7 @@ enum PageErrorCode @doc(category: "Pages") {
ATTRIBUTE_ALREADY_ASSIGNED
}
-input PageCreateInput @doc(category: "Pages") {
+input PageCreateInput {
"""Page internal name."""
slug: String
@@ -24310,8 +26389,12 @@ input PageCreateInput @doc(category: "Pages") {
"""Determines if page is visible in the storefront."""
isPublished: Boolean
- """Publication date. ISO 8601 standard."""
- publicationDate: String @deprecated(reason: "Use `publishedAt` field instead.")
+ """
+ Publication date. ISO 8601 standard.
+
+ DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ """
+ publicationDate: String
"""Publication date time. ISO 8601 standard."""
publishedAt: DateTime
@@ -24328,7 +26411,7 @@ Deletes a page.
Requires one of the following permissions: MANAGE_PAGES.
"""
-type PageDelete @doc(category: "Pages") {
+type PageDelete {
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PageError!]!
page: Page
@@ -24339,7 +26422,7 @@ Deletes pages.
Requires one of the following permissions: MANAGE_PAGES.
"""
-type PageBulkDelete @doc(category: "Pages") {
+type PageBulkDelete {
"""Returns how many objects were affected."""
count: Int!
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24351,7 +26434,7 @@ Publish pages.
Requires one of the following permissions: MANAGE_PAGES.
"""
-type PageBulkPublish @doc(category: "Pages") {
+type PageBulkPublish {
"""Returns how many objects were affected."""
count: Int!
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24363,13 +26446,13 @@ Updates an existing page.
Requires one of the following permissions: MANAGE_PAGES.
"""
-type PageUpdate @doc(category: "Pages") {
+type PageUpdate {
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PageError!]!
page: Page
}
-input PageInput @doc(category: "Pages") {
+input PageInput {
"""Page internal name."""
slug: String
@@ -24389,8 +26472,12 @@ input PageInput @doc(category: "Pages") {
"""Determines if page is visible in the storefront."""
isPublished: Boolean
- """Publication date. ISO 8601 standard."""
- publicationDate: String @deprecated(reason: "Use `publishedAt` field instead.")
+ """
+ Publication date. ISO 8601 standard.
+
+ DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ """
+ publicationDate: String
"""Publication date time. ISO 8601 standard."""
publishedAt: DateTime
@@ -24404,7 +26491,7 @@ Creates/updates translations for a page.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type PageTranslate @doc(category: "Pages") {
+type PageTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
page: PageTranslatableContent
@@ -24429,13 +26516,13 @@ Creates a new page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
-type PageTypeCreate @doc(category: "Pages") {
+type PageTypeCreate {
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PageError!]!
pageType: PageType
}
-input PageTypeCreateInput @doc(category: "Pages") {
+input PageTypeCreateInput {
"""Name of the page type."""
name: String
@@ -24451,13 +26538,13 @@ Updates page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
-type PageTypeUpdate @doc(category: "Pages") {
+type PageTypeUpdate {
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PageError!]!
pageType: PageType
}
-input PageTypeUpdateInput @doc(category: "Pages") {
+input PageTypeUpdateInput {
"""Name of the page type."""
name: String
@@ -24476,7 +26563,7 @@ Deletes a page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
-type PageTypeDelete @doc(category: "Pages") {
+type PageTypeDelete {
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PageError!]!
pageType: PageType
@@ -24487,7 +26574,7 @@ Deletes page types.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
-type PageTypeBulkDelete @doc(category: "Pages") {
+type PageTypeBulkDelete {
"""Returns how many objects were affected."""
count: Int!
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24499,7 +26586,7 @@ Assign attributes to a given page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
-type PageAttributeAssign @doc(category: "Pages") {
+type PageAttributeAssign {
"""The updated page type."""
pageType: PageType
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24511,7 +26598,7 @@ Unassign attributes from a given page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
-type PageAttributeUnassign @doc(category: "Pages") {
+type PageAttributeUnassign {
"""The updated page type."""
pageType: PageType
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24523,7 +26610,7 @@ Reorder the attributes of a page type.
Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
"""
-type PageTypeReorderAttributes @doc(category: "Pages") {
+type PageTypeReorderAttributes {
"""Page type from which attributes are reordered."""
pageType: PageType
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24535,7 +26622,7 @@ Reorder page attribute values.
Requires one of the following permissions: MANAGE_PAGES.
"""
-type PageReorderAttributeValues @doc(category: "Pages") {
+type PageReorderAttributeValues {
"""Page from which attribute values are reordered."""
page: Page
pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24547,7 +26634,7 @@ Completes creating an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type DraftOrderComplete @doc(category: "Orders") {
+type DraftOrderComplete {
"""Completed order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24559,13 +26646,13 @@ Creates a new draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type DraftOrderCreate @doc(category: "Orders") {
+type DraftOrderCreate {
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [OrderError!]!
order: Order
}
-input DraftOrderCreateInput @doc(category: "Orders") {
+input DraftOrderCreateInput {
"""Billing address of the customer."""
billingAddress: AddressInput
@@ -24582,8 +26669,12 @@ input DraftOrderCreateInput @doc(category: "Orders") {
"""Email address of the customer."""
userEmail: String
- """Discount amount for the order."""
- discount: PositiveDecimal @deprecated(reason: "Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.")
+ """
+ Discount amount for the order.
+
+ DEPRECATED: this field will be removed. Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
+ """
+ discount: PositiveDecimal
"""Shipping address of the customer."""
shippingAddress: AddressInput
@@ -24651,7 +26742,7 @@ input DraftOrderCreateInput @doc(category: "Orders") {
lines: [OrderLineCreateInput!]
}
-input OrderLineCreateInput @doc(category: "Orders") {
+input OrderLineCreateInput {
"""Number of variant items ordered."""
quantity: Int!
@@ -24659,7 +26750,7 @@ input OrderLineCreateInput @doc(category: "Orders") {
variantId: ID!
"""
- Flag that allow force splitting the same variant into multiple lines by skipping the matching logic.
+ Flag that allow force splitting the same variant into multiple lines by skipping the matching logic.
"""
forceNewLine: Boolean = false
@@ -24674,7 +26765,7 @@ Deletes a draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type DraftOrderDelete @doc(category: "Orders") {
+type DraftOrderDelete {
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [OrderError!]!
order: Order
@@ -24685,7 +26776,7 @@ Deletes draft orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type DraftOrderBulkDelete @doc(category: "Orders") {
+type DraftOrderBulkDelete {
"""Returns how many objects were affected."""
count: Int!
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24697,7 +26788,7 @@ Deletes order lines.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type DraftOrderLinesBulkDelete @doc(category: "Orders") {
+type DraftOrderLinesBulkDelete {
"""Returns how many objects were affected."""
count: Int!
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24709,13 +26800,13 @@ Updates a draft order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type DraftOrderUpdate @doc(category: "Orders") {
+type DraftOrderUpdate {
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [OrderError!]!
order: Order
}
-input DraftOrderInput @doc(category: "Orders") {
+input DraftOrderInput {
"""Billing address of the customer."""
billingAddress: AddressInput
@@ -24732,8 +26823,12 @@ input DraftOrderInput @doc(category: "Orders") {
"""Email address of the customer."""
userEmail: String
- """Discount amount for the order."""
- discount: PositiveDecimal @deprecated(reason: "Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.")
+ """
+ Discount amount for the order.
+
+ DEPRECATED: this field will be removed. Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
+ """
+ discount: PositiveDecimal
"""Shipping address of the customer."""
shippingAddress: AddressInput
@@ -24803,7 +26898,7 @@ Adds note to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderAddNote @doc(category: "Orders") {
+type OrderAddNote {
"""Order with the note added."""
order: Order
@@ -24813,7 +26908,7 @@ type OrderAddNote @doc(category: "Orders") {
errors: [OrderError!]!
}
-input OrderAddNoteInput @doc(category: "Orders") {
+input OrderAddNoteInput {
"""Note message."""
message: String!
}
@@ -24823,7 +26918,7 @@ Cancel an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderCancel @doc(category: "Orders") {
+type OrderCancel {
"""Canceled order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24835,7 +26930,7 @@ Capture an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderCapture @doc(category: "Orders") {
+type OrderCapture {
"""Captured order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24847,7 +26942,7 @@ Confirms an unconfirmed order by changing status to unfulfilled.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderConfirm @doc(category: "Orders") {
+type OrderConfirm {
"""Order which has been confirmed."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -24865,7 +26960,7 @@ Triggers the following webhook events:
- FULFILLMENT_TRACKING_NUMBER_UPDATED (async): Sent when fulfillment tracking number is updated.
- FULFILLMENT_APPROVED (async): A fulfillment is approved.
"""
-type OrderFulfill @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_CREATED, ORDER_FULFILLED, FULFILLMENT_TRACKING_NUMBER_UPDATED, FULFILLMENT_APPROVED], syncEvents: []) {
+type OrderFulfill {
"""List of created fulfillments."""
fulfillments: [Fulfillment!]
@@ -24875,7 +26970,7 @@ type OrderFulfill @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULF
errors: [OrderError!]!
}
-input OrderFulfillInput @doc(category: "Orders") {
+input OrderFulfillInput {
"""List of items informing how to fulfill the order."""
lines: [OrderFulfillLineInput!]!
@@ -24889,7 +26984,7 @@ input OrderFulfillInput @doc(category: "Orders") {
trackingNumber: String
}
-input OrderFulfillLineInput @doc(category: "Orders") {
+input OrderFulfillLineInput {
"""The ID of the order line."""
orderLineId: ID
@@ -24897,7 +26992,7 @@ input OrderFulfillLineInput @doc(category: "Orders") {
stocks: [OrderFulfillStockInput!]!
}
-input OrderFulfillStockInput @doc(category: "Orders") {
+input OrderFulfillStockInput {
"""The number of line items to be fulfilled from given warehouse."""
quantity: Int!
@@ -24910,7 +27005,7 @@ Cancels existing fulfillment and optionally restocks items.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type FulfillmentCancel @doc(category: "Orders") {
+type FulfillmentCancel {
"""A canceled fulfillment."""
fulfillment: Fulfillment
@@ -24920,7 +27015,7 @@ type FulfillmentCancel @doc(category: "Orders") {
errors: [OrderError!]!
}
-input FulfillmentCancelInput @doc(category: "Orders") {
+input FulfillmentCancelInput {
"""
ID of a warehouse where items will be restocked. Optional when fulfillment is in WAITING_FOR_APPROVAL state.
"""
@@ -24935,7 +27030,7 @@ Requires one of the following permissions: MANAGE_ORDERS.
Triggers the following webhook events:
- FULFILLMENT_APPROVED (async): Fulfillment is approved.
"""
-type FulfillmentApprove @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_APPROVED], syncEvents: []) {
+type FulfillmentApprove {
"""An approved fulfillment."""
fulfillment: Fulfillment
@@ -24953,7 +27048,7 @@ Requires one of the following permissions: MANAGE_ORDERS.
Triggers the following webhook events:
- FULFILLMENT_TRACKING_NUMBER_UPDATED (async): Fulfillment tracking number is updated.
"""
-type FulfillmentUpdateTracking @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_TRACKING_NUMBER_UPDATED], syncEvents: []) {
+type FulfillmentUpdateTracking {
"""A fulfillment with updated tracking."""
fulfillment: Fulfillment
@@ -24963,7 +27058,7 @@ type FulfillmentUpdateTracking @doc(category: "Orders") @webhookEventsInfo(async
errors: [OrderError!]!
}
-input FulfillmentUpdateTrackingInput @doc(category: "Orders") {
+input FulfillmentUpdateTrackingInput {
"""Fulfillment tracking number."""
trackingNumber: String
@@ -24976,7 +27071,7 @@ Refund products.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type FulfillmentRefundProducts @doc(category: "Orders") {
+type FulfillmentRefundProducts {
"""A refunded fulfillment."""
fulfillment: Fulfillment
@@ -24986,7 +27081,7 @@ type FulfillmentRefundProducts @doc(category: "Orders") {
errors: [OrderError!]!
}
-input OrderRefundProductsInput @doc(category: "Orders") {
+input OrderRefundProductsInput {
"""List of unfulfilled lines to refund."""
orderLines: [OrderRefundLineInput!]
@@ -25002,7 +27097,7 @@ input OrderRefundProductsInput @doc(category: "Orders") {
includeShippingCosts: Boolean = false
}
-input OrderRefundLineInput @doc(category: "Orders") {
+input OrderRefundLineInput {
"""The ID of the order line to refund."""
orderLineId: ID!
@@ -25010,7 +27105,7 @@ input OrderRefundLineInput @doc(category: "Orders") {
quantity: Int!
}
-input OrderRefundFulfillmentLineInput @doc(category: "Orders") {
+input OrderRefundFulfillmentLineInput {
"""The ID of the fulfillment line to refund."""
fulfillmentLineId: ID!
@@ -25023,7 +27118,7 @@ Return products.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type FulfillmentReturnProducts @doc(category: "Orders") {
+type FulfillmentReturnProducts {
"""A return fulfillment."""
returnFulfillment: Fulfillment
@@ -25039,7 +27134,7 @@ type FulfillmentReturnProducts @doc(category: "Orders") {
errors: [OrderError!]!
}
-input OrderReturnProductsInput @doc(category: "Orders") {
+input OrderReturnProductsInput {
"""List of unfulfilled lines to return."""
orderLines: [OrderReturnLineInput!]
@@ -25056,9 +27151,23 @@ input OrderReturnProductsInput @doc(category: "Orders") {
"""If true, Saleor will call refund action for all lines."""
refund: Boolean = false
+
+ """
+ Global reason for the return.
+
+ Added in Saleor 3.22.
+ """
+ reason: String
+
+ """
+ ID of a `Page` to reference as reason for the return. Required for staff users when refund reason reference type is configured. Always optional for apps.
+
+ Added in Saleor 3.22.
+ """
+ reasonReference: ID
}
-input OrderReturnLineInput @doc(category: "Orders") {
+input OrderReturnLineInput {
"""The ID of the order line to return."""
orderLineId: ID!
@@ -25067,9 +27176,23 @@ input OrderReturnLineInput @doc(category: "Orders") {
"""Determines, if the line should be added to replace order."""
replace: Boolean = false
+
+ """
+ Reason for returning the line.
+
+ Added in Saleor 3.22.
+ """
+ reason: String
+
+ """
+ ID of a `Page` to reference as reason for returning this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+
+ Added in Saleor 3.22.
+ """
+ reasonReference: ID
}
-input OrderReturnFulfillmentLineInput @doc(category: "Orders") {
+input OrderReturnFulfillmentLineInput {
"""The ID of the fulfillment line to return."""
fulfillmentLineId: ID!
@@ -25078,6 +27201,20 @@ input OrderReturnFulfillmentLineInput @doc(category: "Orders") {
"""Determines, if the line should be added to replace order."""
replace: Boolean = false
+
+ """
+ Reason for returning the line.
+
+ Added in Saleor 3.22.
+ """
+ reason: String
+
+ """
+ ID of a `Page` to reference as reason for returning this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+
+ Added in Saleor 3.22.
+ """
+ reasonReference: ID
}
"""
@@ -25085,7 +27222,7 @@ Adds granted refund to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderGrantRefundCreate @doc(category: "Orders") {
+type OrderGrantRefundCreate {
"""Order which has assigned new grant refund."""
order: Order
@@ -25094,7 +27231,7 @@ type OrderGrantRefundCreate @doc(category: "Orders") {
errors: [OrderGrantRefundCreateError!]!
}
-type OrderGrantRefundCreateError @doc(category: "Orders") {
+type OrderGrantRefundCreateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -25110,7 +27247,7 @@ type OrderGrantRefundCreateError @doc(category: "Orders") {
lines: [OrderGrantRefundCreateLineError!]
}
-enum OrderGrantRefundCreateErrorCode @doc(category: "Orders") {
+enum OrderGrantRefundCreateErrorCode {
GRAPHQL_ERROR
NOT_FOUND
SHIPPING_COSTS_ALREADY_GRANTED
@@ -25141,7 +27278,7 @@ enum OrderGrantRefundCreateLineErrorCode {
QUANTITY_GREATER_THAN_AVAILABLE
}
-input OrderGrantRefundCreateInput @doc(category: "Orders") {
+input OrderGrantRefundCreateInput {
"""
Amount of the granted refund. If not provided, the amount will be calculated automatically based on provided `lines` and `grantRefundForShipping`.
"""
@@ -25173,7 +27310,7 @@ input OrderGrantRefundCreateInput @doc(category: "Orders") {
transactionId: ID!
}
-input OrderGrantRefundCreateLineInput @doc(category: "Orders") {
+input OrderGrantRefundCreateLineInput {
"""The ID of the order line."""
id: ID!
@@ -25182,6 +27319,13 @@ input OrderGrantRefundCreateLineInput @doc(category: "Orders") {
"""Reason of the granted refund for the line."""
reason: String
+
+ """
+ ID of a `Page` to reference as reason for this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+
+ Added in Saleor 3.22.
+ """
+ reasonReference: ID
}
"""
@@ -25189,7 +27333,7 @@ Updates granted refund.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderGrantRefundUpdate @doc(category: "Orders") {
+type OrderGrantRefundUpdate {
"""Order which has assigned updated grant refund."""
order: Order
@@ -25198,7 +27342,7 @@ type OrderGrantRefundUpdate @doc(category: "Orders") {
errors: [OrderGrantRefundUpdateError!]!
}
-type OrderGrantRefundUpdateError @doc(category: "Orders") {
+type OrderGrantRefundUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -25217,7 +27361,7 @@ type OrderGrantRefundUpdateError @doc(category: "Orders") {
removeLines: [OrderGrantRefundUpdateLineError!]
}
-enum OrderGrantRefundUpdateErrorCode @doc(category: "Orders") {
+enum OrderGrantRefundUpdateErrorCode {
GRAPHQL_ERROR
NOT_FOUND
REQUIRED
@@ -25248,7 +27392,7 @@ enum OrderGrantRefundUpdateLineErrorCode {
QUANTITY_GREATER_THAN_AVAILABLE
}
-input OrderGrantRefundUpdateInput @doc(category: "Orders") {
+input OrderGrantRefundUpdateInput {
"""
Amount of the granted refund. if not provided and `addLines` or `removeLines` or `grantRefundForShipping` is provided, amount will be calculated automatically.
"""
@@ -25283,7 +27427,7 @@ input OrderGrantRefundUpdateInput @doc(category: "Orders") {
transactionId: ID
}
-input OrderGrantRefundUpdateLineAddInput @doc(category: "Orders") {
+input OrderGrantRefundUpdateLineAddInput {
"""The ID of the order line."""
id: ID!
@@ -25292,6 +27436,13 @@ input OrderGrantRefundUpdateLineAddInput @doc(category: "Orders") {
"""Reason of the granted refund for the line."""
reason: String
+
+ """
+ ID of a `Page` to reference as reason for this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+
+ Added in Saleor 3.22.
+ """
+ reasonReference: ID
}
"""
@@ -25299,7 +27450,7 @@ Creates order lines for an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderLinesCreate @doc(category: "Orders") {
+type OrderLinesCreate {
"""Related order."""
order: Order
@@ -25314,7 +27465,7 @@ Deletes an order line from an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderLineDelete @doc(category: "Orders") {
+type OrderLineDelete {
"""A related order."""
order: Order
@@ -25329,7 +27480,7 @@ Updates an order line of an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderLineUpdate @doc(category: "Orders") {
+type OrderLineUpdate {
"""Related order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -25337,7 +27488,7 @@ type OrderLineUpdate @doc(category: "Orders") {
orderLine: OrderLine
}
-input OrderLineInput @doc(category: "Orders") {
+input OrderLineInput {
"""Number of variant items ordered."""
quantity: Int!
}
@@ -25347,14 +27498,14 @@ Adds discount to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderDiscountAdd @doc(category: "Orders") {
+type OrderDiscountAdd {
"""Order which has been discounted."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [OrderError!]!
}
-input OrderDiscountCommonInput @doc(category: "Orders") {
+input OrderDiscountCommonInput {
"""Type of the discount: fixed or percent"""
valueType: DiscountValueTypeEnum!
@@ -25370,7 +27521,7 @@ Update discount for the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderDiscountUpdate @doc(category: "Orders") {
+type OrderDiscountUpdate {
"""Order which has been discounted."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -25382,7 +27533,7 @@ Remove discount from the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderDiscountDelete @doc(category: "Orders") {
+type OrderDiscountDelete {
"""Order which has removed discount."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -25394,7 +27545,7 @@ Update discount for the order line.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderLineDiscountUpdate @doc(category: "Orders") {
+type OrderLineDiscountUpdate {
"""Order line which has been discounted."""
orderLine: OrderLine
@@ -25409,7 +27560,7 @@ Remove discount applied to the order line.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderLineDiscountRemove @doc(category: "Orders") {
+type OrderLineDiscountRemove {
"""Order line which has removed discount."""
orderLine: OrderLine
@@ -25424,7 +27575,7 @@ Adds note to the order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderNoteAdd @doc(category: "Orders") {
+type OrderNoteAdd {
"""Order with the note added."""
order: Order
@@ -25433,7 +27584,7 @@ type OrderNoteAdd @doc(category: "Orders") {
errors: [OrderNoteAddError!]!
}
-type OrderNoteAddError @doc(category: "Orders") {
+type OrderNoteAddError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -25446,12 +27597,12 @@ type OrderNoteAddError @doc(category: "Orders") {
code: OrderNoteAddErrorCode
}
-enum OrderNoteAddErrorCode @doc(category: "Orders") {
+enum OrderNoteAddErrorCode {
GRAPHQL_ERROR
REQUIRED
}
-input OrderNoteInput @doc(category: "Orders") {
+input OrderNoteInput {
"""Note message."""
message: String!
}
@@ -25461,7 +27612,7 @@ Updates note of an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderNoteUpdate @doc(category: "Orders") {
+type OrderNoteUpdate {
"""Order with the note updated."""
order: Order
@@ -25470,7 +27621,7 @@ type OrderNoteUpdate @doc(category: "Orders") {
errors: [OrderNoteUpdateError!]!
}
-type OrderNoteUpdateError @doc(category: "Orders") {
+type OrderNoteUpdateError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -25483,7 +27634,7 @@ type OrderNoteUpdateError @doc(category: "Orders") {
code: OrderNoteUpdateErrorCode
}
-enum OrderNoteUpdateErrorCode @doc(category: "Orders") {
+enum OrderNoteUpdateErrorCode {
GRAPHQL_ERROR
NOT_FOUND
REQUIRED
@@ -25494,7 +27645,7 @@ Mark order as manually paid.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderMarkAsPaid @doc(category: "Orders") {
+type OrderMarkAsPaid {
"""Order marked as paid."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -25506,7 +27657,7 @@ Refund an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderRefund @doc(category: "Orders") {
+type OrderRefund {
"""A refunded order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -25518,13 +27669,13 @@ Updates an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderUpdate @doc(category: "Orders") {
+type OrderUpdate {
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [OrderError!]!
order: Order
}
-input OrderUpdateInput @doc(category: "Orders") {
+input OrderUpdateInput {
"""Billing address of the customer."""
billingAddress: AddressInput
@@ -25568,14 +27719,14 @@ Updates a shipping method of the order. Requires shipping method ID to update, w
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderUpdateShipping @doc(category: "Orders") {
+type OrderUpdateShipping {
"""Order with updated shipping method."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [OrderError!]!
}
-input OrderUpdateShippingInput @doc(category: "Orders") {
+input OrderUpdateShippingInput {
"""
ID of the selected shipping method, pass null to remove currently assigned shipping method.
"""
@@ -25587,7 +27738,7 @@ Void an order.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderVoid @doc(category: "Orders") {
+type OrderVoid {
"""A voided order."""
order: Order
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -25599,7 +27750,7 @@ Cancels orders.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type OrderBulkCancel @doc(category: "Orders") {
+type OrderBulkCancel {
"""Returns how many objects were affected."""
count: Int!
orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -25611,7 +27762,7 @@ Creates multiple orders.
Requires one of the following permissions: MANAGE_ORDERS_IMPORT.
"""
-type OrderBulkCreate @doc(category: "Orders") {
+type OrderBulkCreate {
"""Returns how many objects were created."""
count: Int!
@@ -25620,7 +27771,7 @@ type OrderBulkCreate @doc(category: "Orders") {
errors: [OrderBulkCreateError!]!
}
-type OrderBulkCreateResult @doc(category: "Orders") {
+type OrderBulkCreateResult {
"""Order data."""
order: Order
@@ -25628,7 +27779,7 @@ type OrderBulkCreateResult @doc(category: "Orders") {
errors: [OrderBulkCreateError!]
}
-type OrderBulkCreateError @doc(category: "Orders") {
+type OrderBulkCreateError {
"""
Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -25662,7 +27813,7 @@ enum OrderBulkCreateErrorCode {
INCORRECT_CURRENCY
}
-input OrderBulkCreateInput @doc(category: "Orders") {
+input OrderBulkCreateInput {
"""External ID of the order."""
externalReference: String
@@ -25750,7 +27901,7 @@ input OrderBulkCreateInput @doc(category: "Orders") {
invoices: [OrderBulkCreateInvoiceInput!]
}
-input OrderBulkCreateUserInput @doc(category: "Orders") {
+input OrderBulkCreateUserInput {
"""Customer ID associated with the order."""
id: ID
@@ -25761,7 +27912,7 @@ input OrderBulkCreateUserInput @doc(category: "Orders") {
externalReference: String
}
-input OrderBulkCreateNoteInput @doc(category: "Orders") {
+input OrderBulkCreateNoteInput {
"""Note message. Max characters: 255."""
message: String!
@@ -25781,7 +27932,7 @@ input OrderBulkCreateNoteInput @doc(category: "Orders") {
appId: ID
}
-input OrderBulkCreateOrderLineInput @doc(category: "Orders") {
+input OrderBulkCreateOrderLineInput {
"""The ID of the product variant."""
variantId: ID
@@ -25890,7 +28041,7 @@ input OrderBulkCreateOrderLineInput @doc(category: "Orders") {
taxClassPrivateMetadata: [MetadataInput!]
}
-input TaxedMoneyInput @doc(category: "Orders") {
+input TaxedMoneyInput {
"""Gross value of an item."""
gross: PositiveDecimal!
@@ -25898,7 +28049,7 @@ input TaxedMoneyInput @doc(category: "Orders") {
net: PositiveDecimal!
}
-input OrderBulkCreateDeliveryMethodInput @doc(category: "Orders") {
+input OrderBulkCreateDeliveryMethodInput {
"""The ID of the warehouse."""
warehouseId: ID
@@ -25938,7 +28089,7 @@ input OrderBulkCreateDeliveryMethodInput @doc(category: "Orders") {
shippingTaxClassPrivateMetadata: [MetadataInput!]
}
-input OrderBulkCreateFulfillmentInput @doc(category: "Orders") {
+input OrderBulkCreateFulfillmentInput {
"""Fulfillment's tracking code."""
trackingCode: String
@@ -25946,7 +28097,7 @@ input OrderBulkCreateFulfillmentInput @doc(category: "Orders") {
lines: [OrderBulkCreateFulfillmentLineInput!]
}
-input OrderBulkCreateFulfillmentLineInput @doc(category: "Orders") {
+input OrderBulkCreateFulfillmentLineInput {
"""The ID of the product variant."""
variantId: ID
@@ -25966,7 +28117,7 @@ input OrderBulkCreateFulfillmentLineInput @doc(category: "Orders") {
orderLineIndex: Int!
}
-input OrderBulkCreateInvoiceInput @doc(category: "Orders") {
+input OrderBulkCreateInvoiceInput {
"""The date, when the invoice was created."""
createdAt: DateTime!
@@ -25991,13 +28142,7 @@ input OrderBulkCreateInvoiceInput @doc(category: "Orders") {
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.
-"""
+"Determine how stocks should be updated, while processing an order.\n\n SKIP - stocks are not checked and not updated.\n UPDATE - only do update, if there is enough stock.\n FORCE - force update, if there is not enough stock.\n "
enum StockUpdatePolicyEnum {
SKIP
UPDATE
@@ -26070,14 +28215,14 @@ Assigns storefront's navigation menus.
Requires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS.
"""
-type AssignNavigation @doc(category: "Menu") {
+type AssignNavigation {
"""Assigned navigation menu."""
menu: Menu
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [MenuError!]!
}
-type MenuError @doc(category: "Menu") {
+type MenuError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -26118,7 +28263,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_CREATED (async): A menu was created.
"""
-type MenuCreate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_CREATED], syncEvents: []) {
+type MenuCreate {
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [MenuError!]!
menu: Menu
@@ -26160,7 +28305,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_DELETED (async): A menu was deleted.
"""
-type MenuDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: []) {
+type MenuDelete {
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [MenuError!]!
menu: Menu
@@ -26174,7 +28319,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_DELETED (async): A menu was deleted.
"""
-type MenuBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: []) {
+type MenuBulkDelete {
"""Returns how many objects were affected."""
count: Int!
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -26189,7 +28334,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_UPDATED (async): A menu was updated.
"""
-type MenuUpdate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_UPDATED], syncEvents: []) {
+type MenuUpdate {
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [MenuError!]!
menu: Menu
@@ -26211,7 +28356,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_ITEM_CREATED (async): A menu item was created.
"""
-type MenuItemCreate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_CREATED], syncEvents: []) {
+type MenuItemCreate {
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [MenuError!]!
menuItem: MenuItem
@@ -26248,7 +28393,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_ITEM_DELETED (async): A menu item was deleted.
"""
-type MenuItemDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_DELETED], syncEvents: []) {
+type MenuItemDelete {
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [MenuError!]!
menuItem: MenuItem
@@ -26262,7 +28407,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_ITEM_DELETED (async): A menu item was deleted.
"""
-type MenuItemBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_DELETED], syncEvents: []) {
+type MenuItemBulkDelete {
"""Returns how many objects were affected."""
count: Int!
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -26277,7 +28422,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_ITEM_UPDATED (async): A menu item was updated.
"""
-type MenuItemUpdate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_UPDATED], syncEvents: []) {
+type MenuItemUpdate {
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [MenuError!]!
menuItem: MenuItem
@@ -26288,7 +28433,7 @@ Creates/updates translations for a menu item.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type MenuItemTranslate @doc(category: "Menu") {
+type MenuItemTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
menuItem: MenuItem
@@ -26302,7 +28447,7 @@ Requires one of the following permissions: MANAGE_MENUS.
Triggers the following webhook events:
- MENU_ITEM_UPDATED (async): Optionally triggered when sort order or parent changed for menu item.
"""
-type MenuItemMove @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_UPDATED], syncEvents: []) {
+type MenuItemMove {
"""Assigned menu to move within."""
menu: Menu
menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -26330,7 +28475,7 @@ Requires one of the following permissions: MANAGE_ORDERS.
Triggers the following webhook events:
- INVOICE_REQUESTED (async): An invoice was requested.
"""
-type InvoiceRequest @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_REQUESTED], syncEvents: []) {
+type InvoiceRequest {
"""Order related to an invoice."""
order: Order
invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -26338,7 +28483,7 @@ type InvoiceRequest @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [IN
invoice: Invoice
}
-type InvoiceError @doc(category: "Orders") {
+type InvoiceError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -26351,7 +28496,7 @@ type InvoiceError @doc(category: "Orders") {
code: InvoiceErrorCode!
}
-enum InvoiceErrorCode @doc(category: "Orders") {
+enum InvoiceErrorCode {
REQUIRED
NOT_READY
URL_NOT_SET
@@ -26370,7 +28515,7 @@ Requires one of the following permissions: MANAGE_ORDERS.
Triggers the following webhook events:
- INVOICE_DELETED (async): An invoice was requested to delete.
"""
-type InvoiceRequestDelete @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_DELETED], syncEvents: []) {
+type InvoiceRequestDelete {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
@@ -26381,13 +28526,13 @@ Creates a ready to send invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type InvoiceCreate @doc(category: "Orders") {
+type InvoiceCreate {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
-input InvoiceCreateInput @doc(category: "Orders") {
+input InvoiceCreateInput {
"""Invoice number."""
number: String!
@@ -26414,7 +28559,7 @@ Deletes an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type InvoiceDelete @doc(category: "Orders") {
+type InvoiceDelete {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
@@ -26425,13 +28570,13 @@ Updates an invoice.
Requires one of the following permissions: MANAGE_ORDERS.
"""
-type InvoiceUpdate @doc(category: "Orders") {
+type InvoiceUpdate {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
}
-input UpdateInvoiceInput @doc(category: "Orders") {
+input UpdateInvoiceInput {
"""Invoice number"""
number: String
@@ -26462,7 +28607,7 @@ Triggers the following webhook events:
- INVOICE_SENT (async): A notification for invoice send
- NOTIFY_USER (async): A notification for invoice send
"""
-type InvoiceSendNotification @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_SENT, NOTIFY_USER], syncEvents: []) {
+type InvoiceSendNotification {
invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [InvoiceError!]!
invoice: Invoice
@@ -26476,14 +28621,14 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_STATUS_CHANGED (async): A gift card was activated.
"""
-type GiftCardActivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) {
+type GiftCardActivate {
"""Activated gift card."""
giftCard: GiftCard
giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [GiftCardError!]!
}
-type GiftCardError @doc(category: "Gift cards") {
+type GiftCardError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -26499,7 +28644,7 @@ type GiftCardError @doc(category: "Gift cards") {
tags: [String!]
}
-enum GiftCardErrorCode @doc(category: "Gift cards") {
+enum GiftCardErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
@@ -26519,13 +28664,13 @@ Triggers the following webhook events:
- GIFT_CARD_CREATED (async): A gift card was created.
- NOTIFY_USER (async): A notification for created gift card.
"""
-type GiftCardCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_CREATED, NOTIFY_USER], syncEvents: []) {
+type GiftCardCreate {
giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [GiftCardError!]!
giftCard: GiftCard
}
-input GiftCardCreateInput @doc(category: "Gift cards") {
+input GiftCardCreateInput {
"""The gift card tags to add."""
addTags: [String!]
@@ -26550,11 +28695,19 @@ input GiftCardCreateInput @doc(category: "Gift cards") {
"""
privateMetadata: [MetadataInput!]
- """Start date of the gift card in ISO 8601 format."""
- startDate: Date @deprecated
+ """
+ Start date of the gift card in ISO 8601 format.
+
+ DEPRECATED: this field will be removed.
+ """
+ startDate: Date
- """End date of the gift card in ISO 8601 format."""
- endDate: Date @deprecated(reason: "Use `expiryDate` from `expirySettings` instead.")
+ """
+ End date of the gift card in ISO 8601 format.
+
+ DEPRECATED: this field will be removed. Use `expiryDate` from `expirySettings` instead.
+ """
+ endDate: Date
"""Balance of the gift card."""
balance: PriceInput!
@@ -26568,8 +28721,12 @@ input GiftCardCreateInput @doc(category: "Gift cards") {
"""Determine if gift card is active."""
isActive: Boolean!
- """Code to use the gift card."""
- code: String @deprecated(reason: "The code is now auto generated.")
+ """
+ Code to use the gift card.
+
+ DEPRECATED: this field will be removed. The code is now auto generated.
+ """
+ code: String
"""The gift card note from the staff member."""
note: String
@@ -26591,7 +28748,7 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_DELETED (async): A gift card was deleted.
"""
-type GiftCardDelete @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_DELETED], syncEvents: []) {
+type GiftCardDelete {
giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [GiftCardError!]!
giftCard: GiftCard
@@ -26605,7 +28762,7 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated.
"""
-type GiftCardDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) {
+type GiftCardDeactivate {
"""Deactivated gift card."""
giftCard: GiftCard
giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -26620,13 +28777,13 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_UPDATED (async): A gift card was updated.
"""
-type GiftCardUpdate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_UPDATED], syncEvents: []) {
+type GiftCardUpdate {
giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [GiftCardError!]!
giftCard: GiftCard
}
-input GiftCardUpdateInput @doc(category: "Gift cards") {
+input GiftCardUpdateInput {
"""The gift card tags to add."""
addTags: [String!]
@@ -26651,11 +28808,19 @@ input GiftCardUpdateInput @doc(category: "Gift cards") {
"""
privateMetadata: [MetadataInput!]
- """Start date of the gift card in ISO 8601 format."""
- startDate: Date @deprecated
+ """
+ Start date of the gift card in ISO 8601 format.
+
+ DEPRECATED: this field will be removed.
+ """
+ startDate: Date
- """End date of the gift card in ISO 8601 format."""
- endDate: Date @deprecated(reason: "Use `expiryDate` from `expirySettings` instead.")
+ """
+ End date of the gift card in ISO 8601 format.
+
+ DEPRECATED: this field will be removed. Use `expiryDate` from `expirySettings` instead.
+ """
+ endDate: Date
"""The gift card tags to remove."""
removeTags: [String!]
@@ -26672,13 +28837,13 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- NOTIFY_USER (async): A notification for gift card resend.
"""
-type GiftCardResend @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [NOTIFY_USER], syncEvents: []) {
+type GiftCardResend {
"""Gift card which has been sent."""
giftCard: GiftCard
errors: [GiftCardError!]!
}
-input GiftCardResendInput @doc(category: "Gift cards") {
+input GiftCardResendInput {
"""ID of a gift card to resend."""
id: ID!
@@ -26697,7 +28862,7 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_UPDATED (async): A gift card was updated.
"""
-type GiftCardAddNote @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_UPDATED], syncEvents: []) {
+type GiftCardAddNote {
"""Gift card with the note added."""
giftCard: GiftCard
@@ -26706,7 +28871,7 @@ type GiftCardAddNote @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents
errors: [GiftCardError!]!
}
-input GiftCardAddNoteInput @doc(category: "Gift cards") {
+input GiftCardAddNoteInput {
"""Note message."""
message: String!
}
@@ -26720,7 +28885,7 @@ Triggers the following webhook events:
- GIFT_CARD_CREATED (async): A gift card was created.
- NOTIFY_USER (async): A notification for created gift card.
"""
-type GiftCardBulkCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_CREATED, NOTIFY_USER], syncEvents: []) {
+type GiftCardBulkCreate {
"""Returns how many objects were created."""
count: Int!
@@ -26729,7 +28894,7 @@ type GiftCardBulkCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEve
errors: [GiftCardError!]!
}
-input GiftCardBulkCreateInput @doc(category: "Gift cards") {
+input GiftCardBulkCreateInput {
"""The number of cards to issue."""
count: Int!
@@ -26754,7 +28919,7 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_DELETED (async): A gift card was deleted.
"""
-type GiftCardBulkDelete @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_DELETED], syncEvents: []) {
+type GiftCardBulkDelete {
"""Returns how many objects were affected."""
count: Int!
errors: [GiftCardError!]!
@@ -26768,7 +28933,7 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_STATUS_CHANGED (async): A gift card was activated.
"""
-type GiftCardBulkActivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) {
+type GiftCardBulkActivate {
"""Returns how many objects were affected."""
count: Int!
errors: [GiftCardError!]!
@@ -26782,7 +28947,7 @@ Requires one of the following permissions: MANAGE_GIFT_CARD.
Triggers the following webhook events:
- GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated.
"""
-type GiftCardBulkDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) {
+type GiftCardBulkDeactivate {
"""Returns how many objects were affected."""
count: Int!
errors: [GiftCardError!]!
@@ -26890,7 +29055,7 @@ Triggers the following webhook events:
- PROMOTION_CREATED (async): A promotion was created.
- PROMOTION_STARTED (async): Optionally called if promotion was started.
"""
-type PromotionCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_CREATED, PROMOTION_STARTED], syncEvents: []) {
+type PromotionCreate {
errors: [PromotionCreateError!]!
promotion: Promotion
}
@@ -26936,7 +29101,7 @@ enum PromotionCreateErrorCode {
INVALID_GIFT_TYPE
}
-input PromotionCreateInput @doc(category: "Discounts") {
+input PromotionCreateInput {
"""Promotion description."""
description: JSON
@@ -26960,7 +29125,7 @@ input PromotionCreateInput @doc(category: "Discounts") {
rules: [PromotionRuleInput!]
}
-input PromotionRuleInput @doc(category: "Discounts") {
+input PromotionRuleInput {
"""Promotion rule name."""
name: String
@@ -27013,7 +29178,7 @@ input PromotionRuleInput @doc(category: "Discounts") {
gifts: [ID!]
}
-input CataloguePredicateInput @doc(category: "Discounts") {
+input CataloguePredicateInput {
"""Defines the product variant conditions to be met."""
variantPredicate: ProductVariantWhereInput
@@ -27033,7 +29198,7 @@ input CataloguePredicateInput @doc(category: "Discounts") {
OR: [CataloguePredicateInput!]
}
-input OrderPredicateInput @doc(category: "Discounts") {
+input OrderPredicateInput {
"""Defines the conditions related to checkout and order objects."""
discountedObjectPredicate: DiscountedObjectWhereInput
@@ -27044,7 +29209,7 @@ input OrderPredicateInput @doc(category: "Discounts") {
OR: [OrderPredicateInput!]
}
-input DiscountedObjectWhereInput @doc(category: "Discounts") {
+input DiscountedObjectWhereInput {
"""Filter by the base subtotal price."""
baseSubtotalPrice: DecimalFilterInput
@@ -27068,7 +29233,7 @@ Triggers the following webhook events:
- PROMOTION_STARTED (async): Optionally called if promotion was started.
- PROMOTION_ENDED (async): Optionally called if promotion was ended.
"""
-type PromotionUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_UPDATED, PROMOTION_STARTED, PROMOTION_ENDED], syncEvents: []) {
+type PromotionUpdate {
errors: [PromotionUpdateError!]!
promotion: Promotion
}
@@ -27115,7 +29280,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- PROMOTION_DELETED (async): A promotion was deleted.
"""
-type PromotionDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_DELETED], syncEvents: []) {
+type PromotionDelete {
errors: [PromotionDeleteError!]!
promotion: Promotion
}
@@ -27146,7 +29311,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- PROMOTION_RULE_CREATED (async): A promotion rule was created.
"""
-type PromotionRuleCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_RULE_CREATED], syncEvents: []) {
+type PromotionRuleCreate {
errors: [PromotionRuleCreateError!]!
promotionRule: PromotionRule
}
@@ -27253,7 +29418,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- PROMOTION_RULE_UPDATED (async): A promotion rule was updated.
"""
-type PromotionRuleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_RULE_UPDATED], syncEvents: []) {
+type PromotionRuleUpdate {
errors: [PromotionRuleUpdateError!]!
promotionRule: PromotionRule
}
@@ -27366,7 +29531,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- PROMOTION_RULE_DELETED (async): A promotion rule was deleted.
"""
-type PromotionRuleDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_RULE_DELETED], syncEvents: []) {
+type PromotionRuleDelete {
errors: [PromotionRuleDeleteError!]!
promotionRule: PromotionRule
}
@@ -27394,7 +29559,7 @@ Creates/updates translations for a promotion.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type PromotionTranslate @doc(category: "Discounts") {
+type PromotionTranslate {
errors: [TranslationError!]!
promotion: Promotion
}
@@ -27415,7 +29580,7 @@ Creates/updates translations for a promotion rule.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type PromotionRuleTranslate @doc(category: "Discounts") {
+type PromotionRuleTranslate {
errors: [TranslationError!]!
promotionRule: PromotionRule
}
@@ -27439,13 +29604,13 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- PROMOTION_DELETED (async): A promotion was deleted.
"""
-type PromotionBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [PROMOTION_DELETED], syncEvents: []) {
+type PromotionBulkDelete {
"""Returns how many objects were affected."""
count: Int!
errors: [DiscountError!]!
}
-type DiscountError @doc(category: "Discounts") {
+type DiscountError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -27471,7 +29636,7 @@ type DiscountError @doc(category: "Discounts") {
voucherCodes: [String!]
}
-enum DiscountErrorCode @doc(category: "Discounts") {
+enum DiscountErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
@@ -27491,13 +29656,13 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- SALE_CREATED (async): A sale was created.
"""
-type SaleCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_CREATED], syncEvents: []) {
+type SaleCreate {
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
sale: Sale
}
-input SaleInput @doc(category: "Discounts") {
+input SaleInput {
"""Voucher name."""
name: String
@@ -27532,7 +29697,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- SALE_DELETED (async): A sale was deleted.
"""
-type SaleDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_DELETED], syncEvents: []) {
+type SaleDelete {
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
sale: Sale
@@ -27546,7 +29711,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- SALE_DELETED (async): A sale was deleted.
"""
-type SaleBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_DELETED], syncEvents: []) {
+type SaleBulkDelete {
"""Returns how many objects were affected."""
count: Int!
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -27562,7 +29727,7 @@ Triggers the following webhook events:
- SALE_UPDATED (async): A sale was updated.
- SALE_TOGGLE (async): Optionally triggered when a sale is started or stopped.
"""
-type SaleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED, SALE_TOGGLE], syncEvents: []) {
+type SaleUpdate {
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
sale: Sale
@@ -27576,14 +29741,14 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- SALE_UPDATED (async): A sale was updated.
"""
-type SaleAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) {
+type SaleAddCatalogues {
"""Sale of which catalogue IDs will be modified."""
sale: Sale
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
}
-input CatalogueInput @doc(category: "Discounts") {
+input CatalogueInput {
"""Products related to the discount."""
products: [ID!]
@@ -27605,7 +29770,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- SALE_UPDATED (async): A sale was updated.
"""
-type SaleRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) {
+type SaleRemoveCatalogues {
"""Sale of which catalogue IDs will be modified."""
sale: Sale
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -27617,7 +29782,7 @@ Creates/updates translations for a sale.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type SaleTranslate @doc(category: "Discounts") {
+type SaleTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
sale: Sale
@@ -27628,14 +29793,14 @@ Manage sale's availability in channels.
Requires one of the following permissions: MANAGE_DISCOUNTS.
"""
-type SaleChannelListingUpdate @doc(category: "Discounts") {
+type SaleChannelListingUpdate {
"""An updated sale instance."""
sale: Sale
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
}
-input SaleChannelListingInput @doc(category: "Discounts") {
+input SaleChannelListingInput {
"""List of channels to which the sale should be assigned."""
addChannels: [SaleChannelListingAddInput!]
@@ -27643,7 +29808,7 @@ input SaleChannelListingInput @doc(category: "Discounts") {
removeChannels: [ID!]
}
-input SaleChannelListingAddInput @doc(category: "Discounts") {
+input SaleChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
@@ -27660,21 +29825,25 @@ Triggers the following webhook events:
- VOUCHER_CREATED (async): A voucher was created.
- VOUCHER_CODES_CREATED (async): A voucher codes were created.
"""
-type VoucherCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CREATED, VOUCHER_CODES_CREATED], syncEvents: []) {
+type VoucherCreate {
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
voucher: Voucher
}
-input VoucherInput @doc(category: "Discounts") {
+input VoucherInput {
"""Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER."""
type: VoucherTypeEnum
"""Voucher name."""
name: String
- """Code to use the voucher."""
- code: String @deprecated(reason: "Use `addCodes` instead.")
+ """
+ Code to use the voucher.
+
+ DEPRECATED: this field will be removed. Use `addCodes` instead.
+ """
+ code: String
"""
List of codes to add.
@@ -27744,7 +29913,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- VOUCHER_DELETED (async): A voucher was deleted.
"""
-type VoucherDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: []) {
+type VoucherDelete {
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
voucher: Voucher
@@ -27758,7 +29927,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- VOUCHER_DELETED (async): A voucher was deleted.
"""
-type VoucherBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: []) {
+type VoucherBulkDelete {
"""Returns how many objects were affected."""
count: Int!
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -27774,7 +29943,7 @@ Triggers the following webhook events:
- VOUCHER_UPDATED (async): A voucher was updated.
- VOUCHER_CODES_CREATED (async): A voucher code was created.
"""
-type VoucherUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED, VOUCHER_CODES_CREATED], syncEvents: []) {
+type VoucherUpdate {
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
voucher: Voucher
@@ -27788,7 +29957,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- VOUCHER_UPDATED (async): A voucher was updated.
"""
-type VoucherAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) {
+type VoucherAddCatalogues {
"""Voucher of which catalogue IDs will be modified."""
voucher: Voucher
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -27803,7 +29972,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- VOUCHER_UPDATED (async): A voucher was updated.
"""
-type VoucherRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) {
+type VoucherRemoveCatalogues {
"""Voucher of which catalogue IDs will be modified."""
voucher: Voucher
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -27815,7 +29984,7 @@ Creates/updates translations for a voucher.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type VoucherTranslate @doc(category: "Discounts") {
+type VoucherTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
voucher: Voucher
@@ -27829,14 +29998,14 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- VOUCHER_UPDATED (async): A voucher was updated.
"""
-type VoucherChannelListingUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) {
+type VoucherChannelListingUpdate {
"""An updated voucher instance."""
voucher: Voucher
discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [DiscountError!]!
}
-input VoucherChannelListingInput @doc(category: "Discounts") {
+input VoucherChannelListingInput {
"""List of channels to which the voucher should be assigned."""
addChannels: [VoucherChannelListingAddInput!]
@@ -27844,7 +30013,7 @@ input VoucherChannelListingInput @doc(category: "Discounts") {
removeChannels: [ID!]
}
-input VoucherChannelListingAddInput @doc(category: "Discounts") {
+input VoucherChannelListingAddInput {
"""ID of a channel."""
channelId: ID!
@@ -27865,13 +30034,13 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- VOUCHER_CODES_DELETED (async): A voucher codes were deleted.
"""
-type VoucherCodeBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CODES_DELETED], syncEvents: []) {
+type VoucherCodeBulkDelete {
"""Returns how many codes were deleted."""
count: Int!
errors: [VoucherCodeBulkDeleteError!]!
}
-type VoucherCodeBulkDeleteError @doc(category: "Discounts") {
+type VoucherCodeBulkDeleteError {
"""
Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -27887,7 +30056,7 @@ type VoucherCodeBulkDeleteError @doc(category: "Discounts") {
voucherCodes: [ID!]
}
-enum VoucherCodeBulkDeleteErrorCode @doc(category: "Discounts") {
+enum VoucherCodeBulkDeleteErrorCode {
GRAPHQL_ERROR
NOT_FOUND
INVALID
@@ -27902,7 +30071,7 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for the exported file.
- PRODUCT_EXPORT_COMPLETED (async): A notification for the exported file.
"""
-type ExportProducts @doc(category: "Products") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, PRODUCT_EXPORT_COMPLETED], syncEvents: []) {
+type ExportProducts {
"""
The newly created export file job which is responsible for export data.
"""
@@ -27931,7 +30100,7 @@ enum ExportErrorCode {
REQUIRED
}
-input ExportProductsInput @doc(category: "Products") {
+input ExportProductsInput {
"""Determine which products should be exported."""
scope: ExportScope!
@@ -27948,7 +30117,7 @@ input ExportProductsInput @doc(category: "Products") {
fileType: FileTypesEnum!
}
-enum ExportScope @doc(category: "Products") {
+enum ExportScope {
"""Export all products."""
ALL
@@ -27959,7 +30128,7 @@ enum ExportScope @doc(category: "Products") {
FILTER
}
-input ExportInfoInput @doc(category: "Products") {
+input ExportInfoInput {
"""List of attribute ids witch should be exported."""
attributes: [ID!]
@@ -27973,7 +30142,7 @@ input ExportInfoInput @doc(category: "Products") {
fields: [ProductFieldEnum!]
}
-enum ProductFieldEnum @doc(category: "Products") {
+enum ProductFieldEnum {
NAME
DESCRIPTION
PRODUCT_TYPE
@@ -28002,7 +30171,7 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for the exported file.
- GIFT_CARD_EXPORT_COMPLETED (async): A notification for the exported file.
"""
-type ExportGiftCards @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, GIFT_CARD_EXPORT_COMPLETED], syncEvents: []) {
+type ExportGiftCards {
"""
The newly created export file job which is responsible for export data.
"""
@@ -28010,7 +30179,7 @@ type ExportGiftCards @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents
errors: [ExportError!]!
}
-input ExportGiftCardsInput @doc(category: "Gift cards") {
+input ExportGiftCardsInput {
"""Determine which gift cards should be exported."""
scope: ExportScope!
@@ -28036,7 +30205,7 @@ Requires one of the following permissions: MANAGE_DISCOUNTS.
Triggers the following webhook events:
- VOUCHER_CODE_EXPORT_COMPLETED (async): A notification for the exported file.
"""
-type ExportVoucherCodes @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CODE_EXPORT_COMPLETED], syncEvents: []) {
+type ExportVoucherCodes {
"""
The newly created export file job which is responsible for export data.
"""
@@ -28044,7 +30213,7 @@ type ExportVoucherCodes @doc(category: "Discounts") @webhookEventsInfo(asyncEven
errors: [ExportError!]!
}
-input ExportVoucherCodesInput @doc(category: "Discounts") {
+input ExportVoucherCodesInput {
"""
The ID of the voucher. If provided, exports all codes belonging to the voucher.
"""
@@ -28083,6 +30252,8 @@ type UploadError {
enum UploadErrorCode {
GRAPHQL_ERROR
+ INVALID_FILE_TYPE
+ UNSUPPORTED_MIME_TYPE
}
"""
@@ -28091,14 +30262,14 @@ Adds a gift card or a voucher to a checkout.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutAddPromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutAddPromoCode {
"""The checkout with the added gift card or voucher."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CheckoutError!]!
}
-type CheckoutError @doc(category: "Checkout") {
+type CheckoutError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -28120,7 +30291,7 @@ type CheckoutError @doc(category: "Checkout") {
addressType: AddressTypeEnum
}
-enum CheckoutErrorCode @doc(category: "Checkout") {
+enum CheckoutErrorCode {
BILLING_ADDRESS_NOT_SET
CHECKOUT_NOT_FULLY_PAID
GRAPHQL_ERROR
@@ -28161,14 +30332,14 @@ Updates billing address in the existing checkout.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutBillingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutBillingAddressUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CheckoutError!]!
}
-input CheckoutAddressValidationRules @doc(category: "Checkout") {
+input CheckoutAddressValidationRules {
"""
Determines if an error should be raised when the provided address doesn't have all the required fields. The list of required fields is dynamic and depends on the country code (use the `addressValidationRules` query to fetch them). Note: country code is mandatory for all addresses regardless of the rules provided in this input.
"""
@@ -28200,7 +30371,7 @@ Triggers the following webhook events:
- ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.
- ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.
"""
-type CheckoutComplete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [ORDER_CREATED, NOTIFY_USER, NOTIFY_USER, ORDER_UPDATED, ORDER_PAID, ORDER_FULLY_PAID, ORDER_CONFIRMED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS, CHECKOUT_CALCULATE_TAXES]) {
+type CheckoutComplete {
"""Placed order."""
order: Order
@@ -28223,7 +30394,7 @@ Create a new checkout.
Triggers the following webhook events:
- CHECKOUT_CREATED (async): A checkout was created.
"""
-type CheckoutCreate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_CREATED], syncEvents: []) {
+type CheckoutCreate {
"""
Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout.
"""
@@ -28233,7 +30404,7 @@ type CheckoutCreate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [
checkout: Checkout
}
-input CheckoutCreateInput @doc(category: "Checkout") {
+input CheckoutCreateInput {
"""Slug of a channel in which to create a checkout."""
channel: String
@@ -28296,7 +30467,7 @@ input CheckoutCreateInput @doc(category: "Checkout") {
privateMetadata: [MetadataInput!]
}
-input CheckoutLineInput @doc(category: "Checkout") {
+input CheckoutLineInput {
"""The number of items purchased."""
quantity: Int!
@@ -28309,7 +30480,7 @@ input CheckoutLineInput @doc(category: "Checkout") {
price: PositiveDecimal
"""
- Flag that allow force splitting the same variant into multiple lines by skipping the matching logic.
+ Flag that allow force splitting the same variant into multiple lines by skipping the matching logic.
"""
forceNewLine: Boolean = false
@@ -28321,7 +30492,7 @@ input CheckoutLineInput @doc(category: "Checkout") {
metadata: [MetadataInput!]
}
-input CheckoutValidationRules @doc(category: "Checkout") {
+input CheckoutValidationRules {
"""
The validation rules that can be applied to provided shipping address data.
"""
@@ -28334,7 +30505,7 @@ input CheckoutValidationRules @doc(category: "Checkout") {
}
"""Creates a new checkout from existing order."""
-type CheckoutCreateFromOrder @doc(category: "Checkout") {
+type CheckoutCreateFromOrder {
"""Variants that were not attached to the checkout."""
unavailableVariants: [CheckoutCreateFromOrderUnavailableVariant!]
@@ -28343,7 +30514,7 @@ type CheckoutCreateFromOrder @doc(category: "Checkout") {
errors: [CheckoutCreateFromOrderError!]!
}
-type CheckoutCreateFromOrderUnavailableVariant @doc(category: "Checkout") {
+type CheckoutCreateFromOrderUnavailableVariant {
"""The error message."""
message: String!
@@ -28357,7 +30528,7 @@ type CheckoutCreateFromOrderUnavailableVariant @doc(category: "Checkout") {
lineId: ID!
}
-enum CheckoutCreateFromOrderUnavailableVariantErrorCode @doc(category: "Checkout") {
+enum CheckoutCreateFromOrderUnavailableVariantErrorCode {
NOT_FOUND
PRODUCT_UNAVAILABLE_FOR_PURCHASE
UNAVAILABLE_VARIANT_IN_CHANNEL
@@ -28366,7 +30537,7 @@ enum CheckoutCreateFromOrderUnavailableVariantErrorCode @doc(category: "Checkout
INSUFFICIENT_STOCK
}
-type CheckoutCreateFromOrderError @doc(category: "Checkout") {
+type CheckoutCreateFromOrderError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -28379,7 +30550,7 @@ type CheckoutCreateFromOrderError @doc(category: "Checkout") {
code: CheckoutCreateFromOrderErrorCode!
}
-enum CheckoutCreateFromOrderErrorCode @doc(category: "Checkout") {
+enum CheckoutCreateFromOrderErrorCode {
GRAPHQL_ERROR
INVALID
ORDER_NOT_FOUND
@@ -28395,7 +30566,7 @@ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutCustomerAttach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutCustomerAttach {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28410,7 +30581,7 @@ Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutCustomerDetach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutCustomerDetach {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28425,7 +30596,7 @@ Added in Saleor 3.21.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutCustomerNoteUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutCustomerNoteUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28438,7 +30609,7 @@ Updates email address in the existing checkout object.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutEmailUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutEmailUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28451,7 +30622,7 @@ Deletes a CheckoutLine.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutLineDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutLineDelete {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28464,7 +30635,7 @@ Deletes checkout lines.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutLinesDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutLinesDelete {
"""An updated checkout."""
checkout: Checkout
errors: [CheckoutError!]!
@@ -28476,7 +30647,7 @@ Adds a checkout line to the existing checkout.If line was already in checkout, i
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutLinesAdd @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutLinesAdd {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28489,16 +30660,20 @@ Updates checkout line in the existing checkout.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutLinesUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutLinesUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [CheckoutError!]!
}
-input CheckoutLineUpdateInput @doc(category: "Checkout") {
- """ID of the product variant."""
- variantId: ID @deprecated(reason: "Use `lineId` instead.")
+input CheckoutLineUpdateInput {
+ """
+ ID of the product variant.
+
+ DEPRECATED: this field will be removed. Use `lineId` instead.
+ """
+ variantId: ID
"""
The number of items purchased. Optional for apps, required for any other users.
@@ -28529,7 +30704,7 @@ Remove a gift card or a voucher from a checkout.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutRemovePromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutRemovePromoCode {
"""The checkout with the removed gift card or voucher."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28537,7 +30712,7 @@ type CheckoutRemovePromoCode @doc(category: "Checkout") @webhookEventsInfo(async
}
"""Creates a new payment for given checkout."""
-type CheckoutPaymentCreate @doc(category: "Checkout") {
+type CheckoutPaymentCreate {
"""Related checkout object."""
checkout: Checkout
@@ -28547,7 +30722,7 @@ type CheckoutPaymentCreate @doc(category: "Checkout") {
errors: [PaymentError!]!
}
-input PaymentInput @doc(category: "Payments") {
+input PaymentInput {
"""A gateway to use with that payment."""
gateway: String!
@@ -28567,7 +30742,7 @@ input PaymentInput @doc(category: "Payments") {
returnUrl: String
"""Payment store type."""
- storePaymentMethod: StorePaymentMethodEnum = NONE
+ storePaymentMethod: StorePaymentMethodEnum
"""
User public metadata. Can be read by any API client authorized to read the object it's attached to.
@@ -28578,7 +30753,7 @@ input PaymentInput @doc(category: "Payments") {
}
"""Enum representing the type of a payment storage in a gateway."""
-enum StorePaymentMethodEnum @doc(category: "Payments") {
+enum StorePaymentMethodEnum {
"""
On session storage type. The payment is stored only to be reused when the customer is present in the checkout flow.
"""
@@ -28599,7 +30774,7 @@ Updates shipping address in the existing checkout.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutShippingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutShippingAddressUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28613,7 +30788,7 @@ Triggers the following webhook events:
- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout shipping method with the external one.
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutShippingMethodUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT]) {
+type CheckoutShippingMethodUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28627,7 +30802,7 @@ Triggers the following webhook events:
- SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one.
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutDeliveryMethodUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT]) {
+type CheckoutDeliveryMethodUpdate {
"""An updated checkout."""
checkout: Checkout
errors: [CheckoutError!]!
@@ -28639,7 +30814,7 @@ Updates language code in the existing checkout.
Triggers the following webhook events:
- CHECKOUT_UPDATED (async): A checkout was updated.
"""
-type CheckoutLanguageCodeUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) {
+type CheckoutLanguageCodeUpdate {
"""An updated checkout."""
checkout: Checkout
checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -28661,13 +30836,13 @@ Triggers the following webhook events:
- ORDER_FULLY_PAID (async): Triggered when newly created order is fully paid.
- ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed.
"""
-type OrderCreateFromCheckout @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [ORDER_CREATED, NOTIFY_USER, NOTIFY_USER, ORDER_UPDATED, ORDER_PAID, ORDER_FULLY_PAID, ORDER_CONFIRMED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS, CHECKOUT_CALCULATE_TAXES]) {
+type OrderCreateFromCheckout {
"""Placed order."""
order: Order
errors: [OrderCreateFromCheckoutError!]!
}
-type OrderCreateFromCheckoutError @doc(category: "Orders") {
+type OrderCreateFromCheckoutError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -28686,7 +30861,7 @@ type OrderCreateFromCheckoutError @doc(category: "Orders") {
lines: [ID!]
}
-enum OrderCreateFromCheckoutErrorCode @doc(category: "Orders") {
+enum OrderCreateFromCheckoutErrorCode {
GRAPHQL_ERROR
CHECKOUT_NOT_FOUND
CHANNEL_INACTIVE
@@ -28711,13 +30886,13 @@ Requires one of the following permissions: MANAGE_CHANNELS.
Triggers the following webhook events:
- CHANNEL_CREATED (async): A channel was created.
"""
-type ChannelCreate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_CREATED], syncEvents: []) {
+type ChannelCreate {
channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ChannelError!]!
channel: Channel
}
-type ChannelError @doc(category: "Channels") {
+type ChannelError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -28736,7 +30911,7 @@ type ChannelError @doc(category: "Channels") {
warehouses: [ID!]
}
-enum ChannelErrorCode @doc(category: "Channels") {
+enum ChannelErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
@@ -28748,7 +30923,7 @@ enum ChannelErrorCode @doc(category: "Channels") {
DUPLICATED_INPUT_ITEM
}
-input ChannelCreateInput @doc(category: "Channels") {
+input ChannelCreateInput {
"""Determine if channel will be set active or not."""
isActive: Boolean
@@ -28799,14 +30974,14 @@ input ChannelCreateInput @doc(category: "Channels") {
defaultCountry: CountryCode!
}
-input StockSettingsInput @doc(category: "Products") {
+input StockSettingsInput {
"""
Allocation strategy options. Strategy defines the preference of warehouses for allocations and reservations.
"""
allocationStrategy: AllocationStrategyEnum!
}
-input OrderSettingsInput @doc(category: "Orders") {
+input OrderSettingsInput {
"""
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
"""
@@ -28870,18 +31045,22 @@ input OrderSettingsInput @doc(category: "Orders") {
useLegacyLineDiscountPropagation: Boolean
}
-input CheckoutSettingsInput @doc(category: "Checkout") {
+input CheckoutSettingsInput {
"""
- Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
+ Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
+
+ DEPRECATED: this field will be removed.
"""
- useLegacyErrorFlow: Boolean @deprecated
+ useLegacyErrorFlow: Boolean
"""
Default `false`. Determines if the paid checkouts should be automatically completed. This setting applies only to checkouts where payment was processed through transactions.When enabled, the checkout will be automatically completed once the checkout `authorize_status` reaches `FULL`. This occurs when the total sum of charged and authorized transaction amounts equals or exceeds the checkout's total amount.
Added in Saleor 3.20.
+
+ DEPRECATED: this field will be removed. Use `automatic_completion` instead.
"""
- automaticallyCompleteFullyPaidCheckouts: Boolean @deprecated(reason: "Use `automatic_completion` instead.")
+ automaticallyCompleteFullyPaidCheckouts: Boolean
"""
Settings for automatic completion of fully paid checkouts.
@@ -28891,7 +31070,7 @@ input CheckoutSettingsInput @doc(category: "Checkout") {
automaticCompletion: CheckoutAutoCompleteInput
}
-input CheckoutAutoCompleteInput @doc(category: "Checkout") {
+input CheckoutAutoCompleteInput {
"""
Default `false`. Determines if the paid checkouts should be automatically completed. This setting applies only to checkouts where payment was processed through transactions.When enabled, the checkout will be automatically completed once the checkout `charge_status` reaches `FULL`. This occurs when the total sum of charged and authorized transaction amounts equals or exceeds the checkout's total amount.
"""
@@ -28908,7 +31087,7 @@ input CheckoutAutoCompleteInput @doc(category: "Checkout") {
cutOffDate: DateTime
}
-input PaymentSettingsInput @doc(category: "Payments") {
+input PaymentSettingsInput {
"""
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.
"""
@@ -28948,13 +31127,13 @@ Triggers the following webhook events:
- CHANNEL_UPDATED (async): A channel was updated.
- CHANNEL_METADATA_UPDATED (async): Optionally triggered when public or private metadata is updated.
"""
-type ChannelUpdate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_UPDATED, CHANNEL_METADATA_UPDATED], syncEvents: []) {
+type ChannelUpdate {
channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ChannelError!]!
channel: Channel
}
-input ChannelUpdateInput @doc(category: "Channels") {
+input ChannelUpdateInput {
"""Determine if channel will be set active or not."""
isActive: Boolean
@@ -29016,13 +31195,13 @@ Requires one of the following permissions: MANAGE_CHANNELS.
Triggers the following webhook events:
- CHANNEL_DELETED (async): A channel was deleted.
"""
-type ChannelDelete @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_DELETED], syncEvents: []) {
+type ChannelDelete {
channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [ChannelError!]!
channel: Channel
}
-input ChannelDeleteInput @doc(category: "Channels") {
+input ChannelDeleteInput {
"""
ID of a channel to migrate orders from the origin channel. Target channel has to have the same currency as the origin.
"""
@@ -29037,7 +31216,7 @@ Requires one of the following permissions: MANAGE_CHANNELS.
Triggers the following webhook events:
- CHANNEL_STATUS_CHANGED (async): A channel was activated.
"""
-type ChannelActivate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_STATUS_CHANGED], syncEvents: []) {
+type ChannelActivate {
"""Activated channel."""
channel: Channel
channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29052,7 +31231,7 @@ Requires one of the following permissions: MANAGE_CHANNELS.
Triggers the following webhook events:
- CHANNEL_STATUS_CHANGED (async): A channel was deactivated.
"""
-type ChannelDeactivate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_STATUS_CHANGED], syncEvents: []) {
+type ChannelDeactivate {
"""Deactivated channel."""
channel: Channel
channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29064,7 +31243,7 @@ Reorder the warehouses of a channel.
Requires one of the following permissions: MANAGE_CHANNELS.
"""
-type ChannelReorderWarehouses @doc(category: "Channels") {
+type ChannelReorderWarehouses {
"""Channel within the warehouses are reordered."""
channel: Channel
errors: [ChannelError!]!
@@ -29076,14 +31255,14 @@ Creates an attribute.
Triggers the following webhook events:
- ATTRIBUTE_CREATED (async): An attribute was created.
"""
-type AttributeCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_CREATED], syncEvents: []) {
+type AttributeCreate {
"""The created attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AttributeError!]!
}
-type AttributeError @doc(category: "Attributes") {
+type AttributeError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -29096,7 +31275,7 @@ type AttributeError @doc(category: "Attributes") {
code: AttributeErrorCode!
}
-enum AttributeErrorCode @doc(category: "Attributes") {
+enum AttributeErrorCode {
ALREADY_EXISTS
GRAPHQL_ERROR
INVALID
@@ -29110,7 +31289,7 @@ Represents an input for create of attribute.
NOTE: Deprecated fields `filterableInStorefront`, `storefrontSearchPosition` and `availableInGrid` are not supported in bulk mutations: `attributeBulkCreate`, `attributeBulkUpdate`.
"""
-input AttributeCreateInput @doc(category: "Attributes") {
+input AttributeCreateInput {
"""The input type to use for entering attribute values in the dashboard."""
inputType: AttributeInputTypeEnum
@@ -29141,19 +31320,29 @@ input AttributeCreateInput @doc(category: "Attributes") {
"""Whether the attribute should be visible or not in storefront."""
visibleInStorefront: Boolean
- """Whether the attribute can be filtered in storefront."""
- filterableInStorefront: Boolean @deprecated
+ """
+ Whether the attribute can be filtered in storefront.
+
+ DEPRECATED: this field will be removed.
+ """
+ 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.
"""
- storefrontSearchPosition: Int @deprecated
+ storefrontSearchPosition: Int
- """Whether the attribute can be displayed in the admin product list."""
- availableInGrid: Boolean @deprecated
+ """
+ Whether the attribute can be displayed in the admin product list.
+
+ DEPRECATED: this field will be removed.
+ """
+ availableInGrid: Boolean
"""External ID of this attribute."""
externalReference: String
@@ -29168,7 +31357,7 @@ input AttributeCreateInput @doc(category: "Attributes") {
referenceTypes: [ID!]
}
-input AttributeValueCreateInput @doc(category: "Attributes") {
+input AttributeValueCreateInput {
"""
Represent value of the attribute value (e.g. color values for swatch attributes).
"""
@@ -29178,13 +31367,17 @@ input AttributeValueCreateInput @doc(category: "Attributes") {
Represents the text of the attribute value, includes formatting.
Rich text format. For reference see https://editorjs.io/
+
+ DEPRECATED: this field will be removed.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
"""
- richText: JSONString @deprecated(reason: "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 formatting.
+
+ DEPRECATED: this field will be removed.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
"""
- plainText: String @deprecated(reason: "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
@@ -29207,7 +31400,7 @@ Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
Triggers the following webhook events:
- ATTRIBUTE_DELETED (async): An attribute was deleted.
"""
-type AttributeDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: []) {
+type AttributeDelete {
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AttributeError!]!
attribute: Attribute
@@ -29221,7 +31414,7 @@ Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES.
Triggers the following webhook events:
- ATTRIBUTE_UPDATED (async): An attribute was updated.
"""
-type AttributeUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_UPDATED], syncEvents: []) {
+type AttributeUpdate {
"""The updated attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29233,7 +31426,7 @@ Represents an input for update of attribute.
NOTE: Deprecated fields `filterableInStorefront`, `storefrontSearchPosition` and `availableInGrid` are not supported in bulk mutations: `attributeBulkCreate`, `attributeBulkUpdate`.
"""
-input AttributeUpdateInput @doc(category: "Attributes") {
+input AttributeUpdateInput {
"""Name of an attribute displayed in the interface."""
name: String
@@ -29258,19 +31451,29 @@ input AttributeUpdateInput @doc(category: "Attributes") {
"""Whether the attribute should be visible or not in storefront."""
visibleInStorefront: Boolean
- """Whether the attribute can be filtered in storefront."""
- filterableInStorefront: Boolean @deprecated
+ """
+ Whether the attribute can be filtered in storefront.
+
+ DEPRECATED: this field will be removed.
+ """
+ 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.
"""
- storefrontSearchPosition: Int @deprecated
+ storefrontSearchPosition: Int
- """Whether the attribute can be displayed in the admin product list."""
- availableInGrid: Boolean @deprecated
+ """
+ Whether the attribute can be displayed in the admin product list.
+
+ DEPRECATED: this field will be removed.
+ """
+ availableInGrid: Boolean
"""External ID of this product."""
externalReference: String
@@ -29285,7 +31488,7 @@ input AttributeUpdateInput @doc(category: "Attributes") {
referenceTypes: [ID!]
}
-input AttributeValueUpdateInput @doc(category: "Attributes") {
+input AttributeValueUpdateInput {
"""
Represent value of the attribute value (e.g. color values for swatch attributes).
"""
@@ -29295,13 +31498,17 @@ input AttributeValueUpdateInput @doc(category: "Attributes") {
Represents the text of the attribute value, includes formatting.
Rich text format. For reference see https://editorjs.io/
+
+ DEPRECATED: this field will be removed.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
"""
- richText: JSONString @deprecated(reason: "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 formatting.
+
+ DEPRECATED: this field will be removed.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
"""
- plainText: String @deprecated(reason: "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
@@ -29322,7 +31529,7 @@ Creates attributes.
Triggers the following webhook events:
- ATTRIBUTE_CREATED (async): An attribute was created.
"""
-type AttributeBulkCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_CREATED], syncEvents: []) {
+type AttributeBulkCreate {
"""Returns how many objects were created."""
count: Int!
@@ -29331,7 +31538,7 @@ type AttributeBulkCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEv
errors: [AttributeBulkCreateError!]!
}
-type AttributeBulkCreateResult @doc(category: "Attributes") {
+type AttributeBulkCreateResult {
"""Attribute data."""
attribute: Attribute
@@ -29339,7 +31546,7 @@ type AttributeBulkCreateResult @doc(category: "Attributes") {
errors: [AttributeBulkCreateError!]
}
-type AttributeBulkCreateError @doc(category: "Attributes") {
+type AttributeBulkCreateError {
"""
Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -29352,7 +31559,7 @@ type AttributeBulkCreateError @doc(category: "Attributes") {
code: AttributeBulkCreateErrorCode!
}
-enum AttributeBulkCreateErrorCode @doc(category: "Attributes") {
+enum AttributeBulkCreateErrorCode {
ALREADY_EXISTS
BLANK
GRAPHQL_ERROR
@@ -29372,7 +31579,7 @@ Triggers the following webhook events:
- ATTRIBUTE_VALUE_CREATED (async): Called optionally when an attribute value was created.
- ATTRIBUTE_VALUE_DELETED (async): Called optionally when an attribute value was deleted.
"""
-type AttributeBulkUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_UPDATED, ATTRIBUTE_VALUE_CREATED, ATTRIBUTE_VALUE_DELETED], syncEvents: []) {
+type AttributeBulkUpdate {
"""Returns how many objects were updated."""
count: Int!
@@ -29381,7 +31588,7 @@ type AttributeBulkUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEv
errors: [AttributeBulkUpdateError!]!
}
-type AttributeBulkUpdateResult @doc(category: "Attributes") {
+type AttributeBulkUpdateResult {
"""Attribute data."""
attribute: Attribute
@@ -29389,7 +31596,7 @@ type AttributeBulkUpdateResult @doc(category: "Attributes") {
errors: [AttributeBulkUpdateError!]
}
-type AttributeBulkUpdateError @doc(category: "Attributes") {
+type AttributeBulkUpdateError {
"""
Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -29402,7 +31609,7 @@ type AttributeBulkUpdateError @doc(category: "Attributes") {
code: AttributeBulkUpdateErrorCode!
}
-enum AttributeBulkUpdateErrorCode @doc(category: "Attributes") {
+enum AttributeBulkUpdateErrorCode {
ALREADY_EXISTS
BLANK
GRAPHQL_ERROR
@@ -29414,7 +31621,7 @@ enum AttributeBulkUpdateErrorCode @doc(category: "Attributes") {
MAX_LENGTH
}
-input AttributeBulkUpdateInput @doc(category: "Attributes") {
+input AttributeBulkUpdateInput {
"""ID of an attribute to update."""
id: ID
@@ -29430,7 +31637,7 @@ Creates/updates translations for an attribute.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type AttributeTranslate @doc(category: "Attributes") {
+type AttributeTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
attribute: Attribute
@@ -29441,7 +31648,7 @@ Creates/updates translations for attributes.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type AttributeBulkTranslate @doc(category: "Attributes") {
+type AttributeBulkTranslate {
"""Returns how many translations were created/updated."""
count: Int!
@@ -29450,7 +31657,7 @@ type AttributeBulkTranslate @doc(category: "Attributes") {
errors: [AttributeBulkTranslateError!]!
}
-type AttributeBulkTranslateResult @doc(category: "Attributes") {
+type AttributeBulkTranslateResult {
"""Attribute translation data."""
translation: AttributeTranslation
@@ -29471,14 +31678,14 @@ type AttributeBulkTranslateError {
code: AttributeTranslateErrorCode!
}
-enum AttributeTranslateErrorCode @doc(category: "Attributes") {
+enum AttributeTranslateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
}
-input AttributeBulkTranslateInput @doc(category: "Attributes") {
+input AttributeBulkTranslateInput {
"""Attribute ID."""
id: ID
@@ -29500,7 +31707,7 @@ Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES.
Triggers the following webhook events:
- ATTRIBUTE_DELETED (async): An attribute was deleted.
"""
-type AttributeBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: []) {
+type AttributeBulkDelete {
"""Returns how many objects were affected."""
count: Int!
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29516,7 +31723,7 @@ Triggers the following webhook events:
- ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted.
- ATTRIBUTE_UPDATED (async): An attribute was updated.
"""
-type AttributeValueBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: []) {
+type AttributeValueBulkDelete {
"""Returns how many objects were affected."""
count: Int!
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29532,7 +31739,7 @@ Triggers the following webhook events:
- ATTRIBUTE_VALUE_CREATED (async): An attribute value was created.
- ATTRIBUTE_UPDATED (async): An attribute was updated.
"""
-type AttributeValueCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_CREATED, ATTRIBUTE_UPDATED], syncEvents: []) {
+type AttributeValueCreate {
"""The updated attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29549,7 +31756,7 @@ Triggers the following webhook events:
- ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted.
- ATTRIBUTE_UPDATED (async): An attribute was updated.
"""
-type AttributeValueDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: []) {
+type AttributeValueDelete {
"""The updated attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29566,7 +31773,7 @@ Triggers the following webhook events:
- ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated.
- ATTRIBUTE_UPDATED (async): An attribute was updated.
"""
-type AttributeValueUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_UPDATED, ATTRIBUTE_UPDATED], syncEvents: []) {
+type AttributeValueUpdate {
"""The updated attribute."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29579,7 +31786,7 @@ Creates/updates translations for attribute values.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type AttributeValueBulkTranslate @doc(category: "Attributes") {
+type AttributeValueBulkTranslate {
"""Returns how many translations were created/updated."""
count: Int!
@@ -29588,7 +31795,7 @@ type AttributeValueBulkTranslate @doc(category: "Attributes") {
errors: [AttributeValueBulkTranslateError!]!
}
-type AttributeValueBulkTranslateResult @doc(category: "Attributes") {
+type AttributeValueBulkTranslateResult {
"""Attribute value translation data."""
translation: AttributeValueTranslation
@@ -29609,14 +31816,14 @@ type AttributeValueBulkTranslateError {
code: AttributeValueTranslateErrorCode!
}
-enum AttributeValueTranslateErrorCode @doc(category: "Attributes") {
+enum AttributeValueTranslateErrorCode {
GRAPHQL_ERROR
INVALID
NOT_FOUND
REQUIRED
}
-input AttributeValueBulkTranslateInput @doc(category: "Attributes") {
+input AttributeValueBulkTranslateInput {
"""Attribute value ID."""
id: ID
@@ -29649,7 +31856,7 @@ Creates/updates translations for an attribute value.
Requires one of the following permissions: MANAGE_TRANSLATIONS.
"""
-type AttributeValueTranslate @doc(category: "Attributes") {
+type AttributeValueTranslate {
translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [TranslationError!]!
attributeValue: AttributeValue
@@ -29664,7 +31871,7 @@ Triggers the following webhook events:
- ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated.
- ATTRIBUTE_UPDATED (async): An attribute was updated.
"""
-type AttributeReorderValues @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_UPDATED, ATTRIBUTE_UPDATED], syncEvents: []) {
+type AttributeReorderValues {
"""Attribute from which values are reordered."""
attribute: Attribute
attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29677,7 +31884,7 @@ Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER
Triggers the following webhook events:
- APP_INSTALLED (async): An app was installed.
"""
-type AppCreate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: []) {
+type AppCreate {
"""The newly created authentication token."""
authToken: String
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29685,7 +31892,7 @@ type AppCreate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTA
app: App
}
-type AppError @doc(category: "Apps") {
+type AppError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -29701,7 +31908,7 @@ type AppError @doc(category: "Apps") {
permissions: [PermissionEnum!]
}
-enum AppErrorCode @doc(category: "Apps") {
+enum AppErrorCode {
FORBIDDEN
GRAPHQL_ERROR
INVALID
@@ -29719,7 +31926,7 @@ enum AppErrorCode @doc(category: "Apps") {
UNSUPPORTED_SALEOR_VERSION
}
-input AppInput @doc(category: "Apps") {
+input AppInput {
"""Name of the app."""
name: String
@@ -29742,7 +31949,7 @@ Requires one of the following permissions: MANAGE_APPS.
Triggers the following webhook events:
- APP_UPDATED (async): An app was updated.
"""
-type AppUpdate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_UPDATED], syncEvents: []) {
+type AppUpdate {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
app: App
@@ -29756,7 +31963,7 @@ Requires one of the following permissions: MANAGE_APPS.
Triggers the following webhook events:
- APP_DELETED (async): An app was deleted.
"""
-type AppDelete @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_DELETED], syncEvents: []) {
+type AppDelete {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
app: App
@@ -29767,7 +31974,7 @@ Creates a new token.
Requires one of the following permissions: MANAGE_APPS.
"""
-type AppTokenCreate @doc(category: "Apps") {
+type AppTokenCreate {
"""The newly created authentication token."""
authToken: String
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29775,7 +31982,7 @@ type AppTokenCreate @doc(category: "Apps") {
appToken: AppToken
}
-input AppTokenInput @doc(category: "Apps") {
+input AppTokenInput {
"""Name of the token."""
name: String
@@ -29788,14 +31995,14 @@ Deletes an authentication token assigned to app.
Requires one of the following permissions: MANAGE_APPS.
"""
-type AppTokenDelete @doc(category: "Apps") {
+type AppTokenDelete {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
appToken: AppToken
}
"""Verify provided app token."""
-type AppTokenVerify @doc(category: "Apps") {
+type AppTokenVerify {
"""Determine if token is valid or not."""
valid: Boolean!
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29805,13 +32012,13 @@ type AppTokenVerify @doc(category: "Apps") {
"""
Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
"""
-type AppInstall @doc(category: "Apps") {
+type AppInstall {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
}
-input AppInstallInput @doc(category: "Apps") {
+input AppInstallInput {
"""Name of the app to install."""
appName: String
@@ -29833,7 +32040,7 @@ Requires one of the following permissions: MANAGE_APPS.
Triggers the following webhook events:
- APP_INSTALLED (async): An app was installed.
"""
-type AppRetryInstall @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: []) {
+type AppRetryInstall {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
@@ -29844,7 +32051,7 @@ Deletes failed installation.
Requires one of the following permissions: MANAGE_APPS.
"""
-type AppDeleteFailedInstallation @doc(category: "Apps") {
+type AppDeleteFailedInstallation {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
@@ -29855,7 +32062,7 @@ Fetch and validate manifest.
Requires one of the following permissions: MANAGE_APPS.
"""
-type AppFetchManifest @doc(category: "Apps") {
+type AppFetchManifest {
"""The validated manifest."""
manifest: Manifest
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -29863,7 +32070,7 @@ type AppFetchManifest @doc(category: "Apps") {
}
"""The manifest definition."""
-type Manifest @doc(category: "Apps") {
+type Manifest {
"""The identifier of the manifest for the app."""
identifier: String!
@@ -29923,7 +32130,7 @@ type Manifest @doc(category: "Apps") {
brand: AppManifestBrand
}
-type AppManifestExtension @doc(category: "Apps") {
+type AppManifestExtension {
"""List of the app extension's permissions."""
permissions: [Permission!]!
@@ -29961,7 +32168,7 @@ type AppManifestExtension @doc(category: "Apps") {
settings: JSON!
}
-type AppManifestWebhook @doc(category: "Apps") {
+type AppManifestWebhook {
"""The name of the webhook."""
name: String!
@@ -29978,7 +32185,7 @@ type AppManifestWebhook @doc(category: "Apps") {
targetUrl: String!
}
-type AppManifestRequiredSaleorVersion @doc(category: "Apps") {
+type AppManifestRequiredSaleorVersion {
"""Required Saleor version as semver range."""
constraint: String!
@@ -29987,13 +32194,13 @@ type AppManifestRequiredSaleorVersion @doc(category: "Apps") {
}
"""Represents the app's manifest brand data."""
-type AppManifestBrand @doc(category: "Apps") {
+type AppManifestBrand {
"""App's logos details."""
logo: AppManifestBrandLogo!
}
"""Represents the app's manifest brand data."""
-type AppManifestBrandLogo @doc(category: "Apps") {
+type AppManifestBrandLogo {
"""Data URL with a base64 encoded logo image."""
default(
"""
@@ -30004,7 +32211,7 @@ type AppManifestBrandLogo @doc(category: "Apps") {
"""
The format of the image. When not provided, format of the original image will be used.
"""
- format: IconThumbnailFormatEnum = ORIGINAL
+ format: IconThumbnailFormatEnum
): String!
}
@@ -30016,7 +32223,7 @@ Requires one of the following permissions: MANAGE_APPS.
Triggers the following webhook events:
- APP_STATUS_CHANGED (async): An app was activated.
"""
-type AppActivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: []) {
+type AppActivate {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
app: App
@@ -30030,12 +32237,135 @@ Requires one of the following permissions: MANAGE_APPS.
Triggers the following webhook events:
- APP_STATUS_CHANGED (async): An app was deactivated.
"""
-type AppDeactivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: []) {
+type AppDeactivate {
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AppError!]!
app: App
}
+"""
+Add a problem to the calling app.
+
+Added in Saleor 3.22.
+
+Requires one of the following permissions: AUTHENTICATED_APP.
+"""
+type AppProblemCreate {
+ """The created or updated app problem."""
+ appProblem: AppProblem
+ errors: [AppProblemCreateError!]!
+}
+
+type AppProblemCreateError {
+ """
+ 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: AppProblemCreateErrorCode!
+}
+
+enum AppProblemCreateErrorCode {
+ GRAPHQL_ERROR
+ INVALID
+ REQUIRED
+ NOT_FOUND
+}
+
+input AppProblemCreateInput {
+ """
+ The problem message to display. Must be at least 3 characters. Messages longer than 2048 characters will be truncated to 2048 characters with '...' suffix.
+ """
+ message: String!
+
+ """
+ Key identifying the type of problem. App can add multiple problems under the same key, to merge them together or delete them in batch. Must be between 3 and 128 characters.
+ """
+ key: String!
+
+ """
+ If set, the problem becomes critical when count reaches this value. If sent again with higher value than already counted, problem can be de-escalated.
+ """
+ criticalThreshold: PositiveInt
+
+ """
+ Time window in minutes for aggregating problems with the same key. Defaults to 60. If 0, a new problem is always created.
+ """
+ aggregationPeriod: Minute = 60
+}
+
+"""
+Dismiss problems for an app.
+
+Added in Saleor 3.22.
+
+Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
+"""
+type AppProblemDismiss {
+ errors: [AppProblemDismissError!]!
+}
+
+type AppProblemDismissError {
+ """
+ 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: AppProblemDismissErrorCode!
+}
+
+enum AppProblemDismissErrorCode {
+ GRAPHQL_ERROR
+ INVALID
+ REQUIRED
+ NOT_FOUND
+ OUT_OF_SCOPE_APP
+}
+
+"""Input for dismissing app problems. Only one can be specified."""
+input AppProblemDismissInput {
+ """For app callers only - dismiss own problems."""
+ byApp: AppProblemDismissByAppInput
+
+ """For staff callers - dismiss problems by IDs."""
+ byStaffWithIds: AppProblemDismissByStaffWithIdsInput
+
+ """For staff callers - dismiss problems by keys for specified app."""
+ byStaffWithKeys: AppProblemDismissByStaffWithKeysInput
+}
+
+"""Input for app callers to dismiss their own problems."""
+input AppProblemDismissByAppInput {
+ """List of problem IDs to dismiss. Cannot be combined with keys. Max 100."""
+ ids: [ID!]
+
+ """List of problem keys to dismiss. Cannot be combined with ids. Max 100."""
+ keys: [String!]
+}
+
+"""Input for staff callers to dismiss problems by IDs."""
+input AppProblemDismissByStaffWithIdsInput {
+ """List of problem IDs to dismiss. Max 100."""
+ ids: [ID!]!
+}
+
+"""Input for staff callers to dismiss problems by keys."""
+input AppProblemDismissByStaffWithKeysInput {
+ """List of problem keys to dismiss. Max 100."""
+ keys: [String!]!
+
+ """ID of the app whose problems to dismiss."""
+ app: ID!
+}
+
"""
Re-enable sync webhooks for provided app. Can be used to manually re-enable sync webhooks for the app before the cooldown period ends.
@@ -30043,7 +32373,7 @@ Added in Saleor 3.21.
Requires one of the following permissions: MANAGE_APPS.
"""
-type AppReenableSyncWebhooks @doc(category: "Apps") {
+type AppReenableSyncWebhooks {
"""App for which sync webhooks were re-enabled."""
app: App
appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30051,7 +32381,7 @@ type AppReenableSyncWebhooks @doc(category: "Apps") {
}
"""Create JWT token."""
-type CreateToken @doc(category: "Authentication") {
+type CreateToken {
"""JWT token, required to authenticate."""
token: String
@@ -30068,7 +32398,7 @@ type CreateToken @doc(category: "Authentication") {
}
"""Represents errors in account mutations."""
-type AccountError @doc(category: "Users") {
+type AccountError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -30084,7 +32414,7 @@ type AccountError @doc(category: "Users") {
addressType: AddressTypeEnum
}
-enum AccountErrorCode @doc(category: "Users") {
+enum AccountErrorCode {
ACTIVATE_OWN_ACCOUNT
ACTIVATE_SUPERUSER_ACCOUNT
DUPLICATED_INPUT_ITEM
@@ -30126,7 +32456,7 @@ enum AccountErrorCode @doc(category: "Users") {
"""
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") {
+type RefreshToken {
"""JWT token, required to authenticate."""
token: String
@@ -30137,7 +32467,7 @@ type RefreshToken @doc(category: "Authentication") {
}
"""Verify JWT token."""
-type VerifyToken @doc(category: "Authentication") {
+type VerifyToken {
"""User assigned to token."""
user: User
@@ -30162,13 +32492,13 @@ Deactivate all JWT tokens of the currently authenticated user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
-type DeactivateAllUserTokens @doc(category: "Authentication") {
+type DeactivateAllUserTokens {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
}
"""Prepare external authentication URL for user by custom plugin."""
-type ExternalAuthenticationUrl @doc(category: "Authentication") {
+type ExternalAuthenticationUrl {
"""The data returned by authentication plugin."""
authenticationData: JSONString
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30176,7 +32506,7 @@ type ExternalAuthenticationUrl @doc(category: "Authentication") {
}
"""Obtain external access tokens for user by custom plugin."""
-type ExternalObtainAccessTokens @doc(category: "Authentication") {
+type ExternalObtainAccessTokens {
"""The token, required to authenticate."""
token: String
@@ -30193,7 +32523,7 @@ type ExternalObtainAccessTokens @doc(category: "Authentication") {
}
"""Refresh user's access by custom plugin."""
-type ExternalRefresh @doc(category: "Authentication") {
+type ExternalRefresh {
"""The token, required to authenticate."""
token: String
@@ -30210,7 +32540,7 @@ type ExternalRefresh @doc(category: "Authentication") {
}
"""Logout user by custom plugin."""
-type ExternalLogout @doc(category: "Authentication") {
+type ExternalLogout {
"""The data returned by authentication plugin."""
logoutData: JSONString
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30218,7 +32548,7 @@ type ExternalLogout @doc(category: "Authentication") {
}
"""Verify external authentication data by plugin."""
-type ExternalVerify @doc(category: "Authentication") {
+type ExternalVerify {
"""User assigned to data."""
user: User
@@ -30239,7 +32569,7 @@ Triggers the following webhook events:
- ACCOUNT_SET_PASSWORD_REQUESTED (async): Setting a new password for the account is requested.
- STAFF_SET_PASSWORD_REQUESTED (async): Setting a new password for the staff account is requested.
"""
-type RequestPasswordReset @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_SET_PASSWORD_REQUESTED, STAFF_SET_PASSWORD_REQUESTED], syncEvents: []) {
+type RequestPasswordReset {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
}
@@ -30253,11 +32583,11 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for account confirmation.
- ACCOUNT_CONFIRMATION_REQUESTED (async): An account confirmation was requested. This event is always sent regardless of settings.
"""
-type SendConfirmationEmail @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_CONFIRMATION_REQUESTED], syncEvents: []) {
+type SendConfirmationEmail {
errors: [SendConfirmationEmailError!]!
}
-type SendConfirmationEmailError @doc(category: "Users") {
+type SendConfirmationEmailError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -30270,7 +32600,7 @@ type SendConfirmationEmailError @doc(category: "Users") {
code: SendConfirmationEmailErrorCode!
}
-enum SendConfirmationEmailErrorCode @doc(category: "Users") {
+enum SendConfirmationEmailErrorCode {
INVALID
ACCOUNT_CONFIRMED
CONFIRMATION_ALREADY_REQUESTED
@@ -30283,7 +32613,7 @@ Confirm user account with token sent by email during registration.
Triggers the following webhook events:
- ACCOUNT_CONFIRMED (async): Account was confirmed.
"""
-type ConfirmAccount @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACCOUNT_CONFIRMED], syncEvents: []) {
+type ConfirmAccount {
"""An activated user account."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30293,7 +32623,7 @@ type ConfirmAccount @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACC
"""
Sets the user's password from the token sent by email using the RequestPasswordReset mutation.
"""
-type SetPassword @doc(category: "Users") {
+type SetPassword {
"""JWT token, required to authenticate."""
token: String
@@ -30314,7 +32644,7 @@ Change the password of the logged in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
-type PasswordChange @doc(category: "Users") {
+type PasswordChange {
"""A user instance with a new password."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30330,7 +32660,7 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for account email change.
- ACCOUNT_CHANGE_EMAIL_REQUESTED (async): An account email change was requested.
"""
-type RequestEmailChange @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_CHANGE_EMAIL_REQUESTED], syncEvents: []) {
+type RequestEmailChange {
"""A user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30347,7 +32677,7 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification that account email change was confirmed.
- ACCOUNT_EMAIL_CHANGED (async): An account email was changed.
"""
-type ConfirmEmailChange @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, NOTIFY_USER, ACCOUNT_EMAIL_CHANGED], syncEvents: []) {
+type ConfirmEmailChange {
"""A user instance with a new email."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30363,7 +32693,7 @@ Triggers the following webhook events:
- CUSTOMER_UPDATED (async): A customer account was updated.
- ADDRESS_CREATED (async): An address was created.
"""
-type AccountAddressCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, ADDRESS_CREATED], syncEvents: []) {
+type AccountAddressCreate {
"""A user instance for which the address was created."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30377,7 +32707,7 @@ Updates an address of the logged-in user. Requires one of the following permissi
Triggers the following webhook events:
- ADDRESS_UPDATED (async): An address was updated.
"""
-type AccountAddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: []) {
+type AccountAddressUpdate {
"""A user object for which the address was edited."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30391,7 +32721,7 @@ Deletes an address of the logged-in user. Requires one of the following permissi
Triggers the following webhook events:
- ADDRESS_DELETED (async): An address was deleted.
"""
-type AccountAddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: []) {
+type AccountAddressDelete {
"""A user instance for which the address was deleted."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30407,7 +32737,7 @@ Requires one of the following permissions: AUTHENTICATED_USER.
Triggers the following webhook events:
- CUSTOMER_UPDATED (async): A customer's address was updated.
"""
-type AccountSetDefaultAddress @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED], syncEvents: []) {
+type AccountSetDefaultAddress {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30422,7 +32752,7 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for account confirmation.
- ACCOUNT_CONFIRMATION_REQUESTED (async): An user confirmation was requested. This event is always sent regardless of settings.
"""
-type AccountRegister @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_CREATED, NOTIFY_USER, ACCOUNT_CONFIRMATION_REQUESTED], syncEvents: []) {
+type AccountRegister {
user: User @deprecated(reason: "The field always returns a `User` object constructed from the input data. The `user.id` is always empty. To determine whether the user exists in Saleor, query via an external app with the required permissions.")
"""Informs whether users need to confirm their email address."""
@@ -30432,7 +32762,7 @@ type AccountRegister @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CU
}
"""Fields required to create a user."""
-input AccountRegisterInput @doc(category: "Users") {
+input AccountRegisterInput {
"""Given name."""
firstName: String
@@ -30475,14 +32805,14 @@ Triggers the following webhook events:
- CUSTOMER_UPDATED (async): A customer account was updated.
- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.
"""
-type AccountUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: []) {
+type AccountUpdate {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""Fields required to update the user."""
-input AccountInput @doc(category: "Users") {
+input AccountInput {
"""Given name."""
firstName: String
@@ -30515,7 +32845,7 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for account delete request.
- ACCOUNT_DELETE_REQUESTED (async): An account delete requested.
"""
-type AccountRequestDeletion @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_DELETE_REQUESTED], syncEvents: []) {
+type AccountRequestDeletion {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
}
@@ -30528,7 +32858,7 @@ Requires one of the following permissions: AUTHENTICATED_USER.
Triggers the following webhook events:
- ACCOUNT_DELETED (async): Account was deleted.
"""
-type AccountDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACCOUNT_DELETED], syncEvents: []) {
+type AccountDelete {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
user: User
@@ -30542,7 +32872,7 @@ Requires one of the following permissions: MANAGE_USERS.
Triggers the following webhook events:
- ADDRESS_CREATED (async): A new address was created.
"""
-type AddressCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_CREATED], syncEvents: []) {
+type AddressCreate {
"""A user instance for which the address was created."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30558,7 +32888,7 @@ Requires one of the following permissions: MANAGE_USERS.
Triggers the following webhook events:
- ADDRESS_UPDATED (async): An address was updated.
"""
-type AddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: []) {
+type AddressUpdate {
"""A user object for which the address was edited."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30574,7 +32904,7 @@ Requires one of the following permissions: MANAGE_USERS.
Triggers the following webhook events:
- ADDRESS_DELETED (async): An address was deleted.
"""
-type AddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: []) {
+type AddressDelete {
"""A user instance for which the address was deleted."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30590,7 +32920,7 @@ Requires one of the following permissions: MANAGE_USERS.
Triggers the following webhook events:
- CUSTOMER_UPDATED (async): A customer was updated.
"""
-type AddressSetDefault @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED], syncEvents: []) {
+type AddressSetDefault {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30608,13 +32938,13 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for setting the password.
- ACCOUNT_SET_PASSWORD_REQUESTED (async): Setting a new password for the account is requested.
"""
-type CustomerCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_CREATED, CUSTOMER_METADATA_UPDATED, NOTIFY_USER, ACCOUNT_SET_PASSWORD_REQUESTED], syncEvents: []) {
+type CustomerCreate {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
-input UserCreateInput @doc(category: "Users") {
+input UserCreateInput {
"""Billing address of the customer."""
defaultBillingAddress: AddressInput
@@ -30656,8 +32986,14 @@ input UserCreateInput @doc(category: "Users") {
"""External ID of the customer."""
externalReference: String
- """User account is confirmed."""
- isConfirmed: Boolean @deprecated(reason: "The user will be always set as unconfirmed. The confirmation will take place when the user sets the password.")
+ """
+ User account is confirmed.
+
+ DEPRECATED: this field will be removed.
+
+ The user will be always set as unconfirmed. The confirmation will take place when the user sets the password.
+ """
+ isConfirmed: Boolean
"""
URL of a view where users should be redirected to set the password. URL in RFC 1808 format.
@@ -30679,13 +33015,13 @@ Triggers the following webhook events:
- CUSTOMER_UPDATED (async): A new customer account was updated.
- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.
"""
-type CustomerUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: []) {
+type CustomerUpdate {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
-input CustomerInput @doc(category: "Users") {
+input CustomerInput {
"""Billing address of the customer."""
defaultBillingAddress: AddressInput
@@ -30739,7 +33075,7 @@ Requires one of the following permissions: MANAGE_USERS.
Triggers the following webhook events:
- CUSTOMER_DELETED (async): A customer account was deleted.
"""
-type CustomerDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_DELETED], syncEvents: []) {
+type CustomerDelete {
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [AccountError!]!
user: User
@@ -30753,7 +33089,7 @@ Requires one of the following permissions: MANAGE_USERS.
Triggers the following webhook events:
- CUSTOMER_DELETED (async): A customer account was deleted.
"""
-type CustomerBulkDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_DELETED], syncEvents: []) {
+type CustomerBulkDelete {
"""Returns how many objects were affected."""
count: Int!
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30769,7 +33105,7 @@ Triggers the following webhook events:
- CUSTOMER_UPDATED (async): A customer account was updated.
- CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated.
"""
-type CustomerBulkUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: []) {
+type CustomerBulkUpdate {
"""Returns how many objects were created."""
count: Int!
@@ -30778,7 +33114,7 @@ type CustomerBulkUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents:
errors: [CustomerBulkUpdateError!]!
}
-type CustomerBulkResult @doc(category: "Users") {
+type CustomerBulkResult {
"""Customer data."""
customer: User
@@ -30786,7 +33122,7 @@ type CustomerBulkResult @doc(category: "Users") {
errors: [CustomerBulkUpdateError!]
}
-type CustomerBulkUpdateError @doc(category: "Users") {
+type CustomerBulkUpdateError {
"""
Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -30799,7 +33135,7 @@ type CustomerBulkUpdateError @doc(category: "Users") {
code: CustomerBulkUpdateErrorCode!
}
-enum CustomerBulkUpdateErrorCode @doc(category: "Users") {
+enum CustomerBulkUpdateErrorCode {
BLANK
DUPLICATED_INPUT_ITEM
GRAPHQL_ERROR
@@ -30810,7 +33146,7 @@ enum CustomerBulkUpdateErrorCode @doc(category: "Users") {
MAX_LENGTH
}
-input CustomerBulkUpdateInput @doc(category: "Users") {
+input CustomerBulkUpdateInput {
"""ID of a customer to update."""
id: ID
@@ -30831,13 +33167,13 @@ Triggers the following webhook events:
- NOTIFY_USER (async): A notification for setting the password.
- STAFF_SET_PASSWORD_REQUESTED (async): Setting a new password for the staff account is requested.
"""
-type StaffCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_CREATED, NOTIFY_USER, STAFF_SET_PASSWORD_REQUESTED], syncEvents: []) {
+type StaffCreate {
staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [StaffError!]!
user: User
}
-type StaffError @doc(category: "Users") {
+type StaffError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -30863,7 +33199,7 @@ type StaffError @doc(category: "Users") {
}
"""Fields required to create a staff user."""
-input StaffCreateInput @doc(category: "Users") {
+input StaffCreateInput {
"""Given name."""
firstName: String
@@ -30910,14 +33246,14 @@ Requires one of the following permissions: MANAGE_STAFF.
Triggers the following webhook events:
- STAFF_UPDATED (async): A staff account was updated.
"""
-type StaffUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_UPDATED], syncEvents: []) {
+type StaffUpdate {
staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [StaffError!]!
user: User
}
"""Fields required to update a staff user."""
-input StaffUpdateInput @doc(category: "Users") {
+input StaffUpdateInput {
"""Given name."""
firstName: String
@@ -30962,7 +33298,7 @@ Requires one of the following permissions: MANAGE_STAFF.
Triggers the following webhook events:
- STAFF_DELETED (async): A staff account was deleted.
"""
-type StaffDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: []) {
+type StaffDelete {
staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [StaffError!]!
user: User
@@ -30976,7 +33312,7 @@ Requires one of the following permissions: MANAGE_STAFF.
Triggers the following webhook events:
- STAFF_DELETED (async): A staff account was deleted.
"""
-type StaffBulkDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: []) {
+type StaffBulkDelete {
"""Returns how many objects were affected."""
count: Int!
staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -30988,7 +33324,7 @@ Create a user avatar. Only for staff members. This mutation must be sent as a `m
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
-type UserAvatarUpdate @doc(category: "Users") {
+type UserAvatarUpdate {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -31000,7 +33336,7 @@ Deletes a user avatar. Only for staff members.
Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
"""
-type UserAvatarDelete @doc(category: "Users") {
+type UserAvatarDelete {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -31012,7 +33348,7 @@ Activate or deactivate users.
Requires one of the following permissions: MANAGE_USERS.
"""
-type UserBulkSetActive @doc(category: "Users") {
+type UserBulkSetActive {
"""Returns how many objects were affected."""
count: Int!
accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.")
@@ -31027,13 +33363,13 @@ Requires one of the following permissions: MANAGE_STAFF.
Triggers the following webhook events:
- PERMISSION_GROUP_CREATED (async)
"""
-type PermissionGroupCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_CREATED], syncEvents: []) {
+type PermissionGroupCreate {
permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PermissionGroupError!]!
group: Group
}
-type PermissionGroupError @doc(category: "Users") {
+type PermissionGroupError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
@@ -31055,7 +33391,7 @@ type PermissionGroupError @doc(category: "Users") {
channels: [ID!]
}
-enum PermissionGroupErrorCode @doc(category: "Users") {
+enum PermissionGroupErrorCode {
REQUIRED
UNIQUE
ASSIGN_NON_STAFF_MEMBER
@@ -31067,7 +33403,7 @@ enum PermissionGroupErrorCode @doc(category: "Users") {
OUT_OF_SCOPE_CHANNEL
}
-input PermissionGroupCreateInput @doc(category: "Users") {
+input PermissionGroupCreateInput {
"""List of permission code names to assign to this group."""
addPermissions: [PermissionEnum!]
@@ -31094,13 +33430,13 @@ Requires one of the following permissions: MANAGE_STAFF.
Triggers the following webhook events:
- PERMISSION_GROUP_UPDATED (async)
"""
-type PermissionGroupUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_UPDATED], syncEvents: []) {
+type PermissionGroupUpdate {
permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PermissionGroupError!]!
group: Group
}
-input PermissionGroupUpdateInput @doc(category: "Users") {
+input PermissionGroupUpdateInput {
"""List of permission code names to assign to this group."""
addPermissions: [PermissionEnum!]
@@ -31134,13 +33470,13 @@ Requires one of the following permissions: MANAGE_STAFF.
Triggers the following webhook events:
- PERMISSION_GROUP_DELETED (async)
"""
-type PermissionGroupDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_DELETED], syncEvents: []) {
+type PermissionGroupDelete {
permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "Use `errors` field instead.")
errors: [PermissionGroupError!]!
group: Group
}
-type Subscription @doc(category: "Miscellaneous") {
+type Subscription {
"""Look up subscription event."""
event: Event
@@ -31156,7 +33492,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): DraftOrderCreated @doc(category: "Orders")
+ ): DraftOrderCreated
"""
Event sent when draft order is updated.
@@ -31170,7 +33506,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): DraftOrderUpdated @doc(category: "Orders")
+ ): DraftOrderUpdated
"""
Event sent when draft order is deleted.
@@ -31184,7 +33520,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): DraftOrderDeleted @doc(category: "Orders")
+ ): DraftOrderDeleted
"""
Event sent when new order is created.
@@ -31198,7 +33534,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderCreated @doc(category: "Orders")
+ ): OrderCreated
"""
Event sent when order is updated.
@@ -31212,7 +33548,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderUpdated @doc(category: "Orders")
+ ): OrderUpdated
"""
Event sent when order is confirmed.
@@ -31226,7 +33562,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderConfirmed @doc(category: "Orders")
+ ): OrderConfirmed
"""
Payment has been made. The order may be partially or fully paid.
@@ -31240,7 +33576,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderPaid @doc(category: "Orders")
+ ): OrderPaid
"""
Event sent when order is fully paid.
@@ -31254,7 +33590,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderFullyPaid @doc(category: "Orders")
+ ): OrderFullyPaid
"""
The order received a refund. The order may be partially or fully refunded.
@@ -31268,7 +33604,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderRefunded @doc(category: "Orders")
+ ): OrderRefunded
"""
The order is fully refunded.
@@ -31282,7 +33618,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderFullyRefunded @doc(category: "Orders")
+ ): OrderFullyRefunded
"""
Event sent when order is fulfilled.
@@ -31296,7 +33632,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderFulfilled @doc(category: "Orders")
+ ): OrderFulfilled
"""
Event sent when order is cancelled.
@@ -31310,7 +33646,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderCancelled @doc(category: "Orders")
+ ): OrderCancelled
"""
Event sent when order becomes expired.
@@ -31324,7 +33660,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderExpired @doc(category: "Orders")
+ ): OrderExpired
"""
Event sent when order metadata is updated.
@@ -31338,7 +33674,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderMetadataUpdated @doc(category: "Orders")
+ ): OrderMetadataUpdated
"""
Event sent when orders are imported.
@@ -31352,7 +33688,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): OrderBulkCreated @doc(category: "Orders")
+ ): OrderBulkCreated
"""
Event sent when new checkout is created.
@@ -31366,7 +33702,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): CheckoutCreated @doc(category: "Checkout")
+ ): CheckoutCreated
"""
Event sent when checkout is updated.
@@ -31380,7 +33716,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): CheckoutUpdated @doc(category: "Checkout")
+ ): CheckoutUpdated
"""
Event sent when checkout is fully-paid.
@@ -31394,7 +33730,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): CheckoutFullyPaid @doc(category: "Checkout")
+ ): CheckoutFullyPaid
"""
Event sent when checkout is fully authorized.
@@ -31408,7 +33744,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): CheckoutFullyAuthorized @doc(category: "Checkout")
+ ): CheckoutFullyAuthorized
"""
Event sent when checkout metadata is updated.
@@ -31422,7 +33758,7 @@ type Subscription @doc(category: "Miscellaneous") {
List of channel slugs. The event will be sent only if the object belongs to one of the provided channels. If the channel slug list is empty, objects that belong to any channel will be sent. Maximally 500 items.
"""
channels: [String!]
- ): CheckoutMetadataUpdated @doc(category: "Checkout")
+ ): CheckoutMetadataUpdated
}
interface Event {
@@ -31436,13 +33772,13 @@ interface Event {
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
- recipient: App @doc(category: "Apps")
+ recipient: App
}
union IssuingPrincipal = App | User
"""Event sent when new draft order is created."""
-type DraftOrderCreated implements Event @doc(category: "Orders") {
+type DraftOrderCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31460,7 +33796,7 @@ type DraftOrderCreated implements Event @doc(category: "Orders") {
}
"""Event sent when draft order is updated."""
-type DraftOrderUpdated implements Event @doc(category: "Orders") {
+type DraftOrderUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31478,7 +33814,7 @@ type DraftOrderUpdated implements Event @doc(category: "Orders") {
}
"""Event sent when draft order is deleted."""
-type DraftOrderDeleted implements Event @doc(category: "Orders") {
+type DraftOrderDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31496,7 +33832,7 @@ type DraftOrderDeleted implements Event @doc(category: "Orders") {
}
"""Event sent when new order is created."""
-type OrderCreated implements Event @doc(category: "Orders") {
+type OrderCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31514,7 +33850,7 @@ type OrderCreated implements Event @doc(category: "Orders") {
}
"""Event sent when order is updated."""
-type OrderUpdated implements Event @doc(category: "Orders") {
+type OrderUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31532,7 +33868,7 @@ type OrderUpdated implements Event @doc(category: "Orders") {
}
"""Event sent when order is confirmed."""
-type OrderConfirmed implements Event @doc(category: "Orders") {
+type OrderConfirmed implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31550,7 +33886,7 @@ type OrderConfirmed implements Event @doc(category: "Orders") {
}
"""Payment has been made. The order may be partially or fully paid."""
-type OrderPaid implements Event @doc(category: "Orders") {
+type OrderPaid implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31568,7 +33904,7 @@ type OrderPaid implements Event @doc(category: "Orders") {
}
"""Event sent when order is fully paid."""
-type OrderFullyPaid implements Event @doc(category: "Orders") {
+type OrderFullyPaid implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31588,7 +33924,7 @@ type OrderFullyPaid implements Event @doc(category: "Orders") {
"""
The order received a refund. The order may be partially or fully refunded.
"""
-type OrderRefunded implements Event @doc(category: "Orders") {
+type OrderRefunded implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31606,7 +33942,7 @@ type OrderRefunded implements Event @doc(category: "Orders") {
}
"""The order is fully refunded."""
-type OrderFullyRefunded implements Event @doc(category: "Orders") {
+type OrderFullyRefunded implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31624,7 +33960,7 @@ type OrderFullyRefunded implements Event @doc(category: "Orders") {
}
"""Event sent when order is fulfilled."""
-type OrderFulfilled implements Event @doc(category: "Orders") {
+type OrderFulfilled implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31642,7 +33978,7 @@ type OrderFulfilled implements Event @doc(category: "Orders") {
}
"""Event sent when order is canceled."""
-type OrderCancelled implements Event @doc(category: "Orders") {
+type OrderCancelled implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31660,7 +33996,7 @@ type OrderCancelled implements Event @doc(category: "Orders") {
}
"""Event sent when order becomes expired."""
-type OrderExpired implements Event @doc(category: "Orders") {
+type OrderExpired implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31678,7 +34014,7 @@ type OrderExpired implements Event @doc(category: "Orders") {
}
"""Event sent when order metadata is updated."""
-type OrderMetadataUpdated implements Event @doc(category: "Orders") {
+type OrderMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31696,7 +34032,7 @@ type OrderMetadataUpdated implements Event @doc(category: "Orders") {
}
"""Event sent when orders are imported."""
-type OrderBulkCreated implements Event @doc(category: "Orders") {
+type OrderBulkCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31714,7 +34050,7 @@ type OrderBulkCreated implements Event @doc(category: "Orders") {
}
"""Event sent when new checkout is created."""
-type CheckoutCreated implements Event @doc(category: "Checkout") {
+type CheckoutCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31732,7 +34068,7 @@ type CheckoutCreated implements Event @doc(category: "Checkout") {
}
"""Event sent when checkout is updated."""
-type CheckoutUpdated implements Event @doc(category: "Checkout") {
+type CheckoutUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31754,7 +34090,7 @@ Event sent when a checkout was fully paid. A checkout is considered fully paid w
It is triggered only for checkouts whose payments are processed through the Transaction API.
"""
-type CheckoutFullyPaid implements Event @doc(category: "Checkout") {
+type CheckoutFullyPaid implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31776,7 +34112,7 @@ Event sent when a checkout was fully authorized. A checkout is considered fully
It is triggered only for checkouts whose payments are processed through the Transaction API.
"""
-type CheckoutFullyAuthorized implements Event @doc(category: "Checkout") {
+type CheckoutFullyAuthorized implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31794,7 +34130,7 @@ type CheckoutFullyAuthorized implements Event @doc(category: "Checkout") {
}
"""Event sent when checkout metadata is updated."""
-type CheckoutMetadataUpdated implements Event @doc(category: "Checkout") {
+type CheckoutMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31852,7 +34188,7 @@ enum VolumeUnitsEnum {
"""
Event sent when account confirmation requested. This event is always sent. enableAccountConfirmationByEmail flag set to True is not required.
"""
-type AccountConfirmationRequested implements Event @doc(category: "Users") {
+type AccountConfirmationRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31882,7 +34218,7 @@ type AccountConfirmationRequested implements Event @doc(category: "Users") {
}
"""Event sent when account change email is requested."""
-type AccountChangeEmailRequested implements Event @doc(category: "Users") {
+type AccountChangeEmailRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31915,7 +34251,7 @@ type AccountChangeEmailRequested implements Event @doc(category: "Users") {
}
"""Event sent when account email is changed."""
-type AccountEmailChanged implements Event @doc(category: "Users") {
+type AccountEmailChanged implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31948,7 +34284,7 @@ type AccountEmailChanged implements Event @doc(category: "Users") {
}
"""Event sent when setting a new password is requested."""
-type AccountSetPasswordRequested implements Event @doc(category: "Users") {
+type AccountSetPasswordRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -31978,7 +34314,7 @@ type AccountSetPasswordRequested implements Event @doc(category: "Users") {
}
"""Event sent when account is confirmed."""
-type AccountConfirmed implements Event @doc(category: "Users") {
+type AccountConfirmed implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32008,7 +34344,7 @@ type AccountConfirmed implements Event @doc(category: "Users") {
}
"""Event sent when account delete is requested."""
-type AccountDeleteRequested implements Event @doc(category: "Users") {
+type AccountDeleteRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32038,7 +34374,7 @@ type AccountDeleteRequested implements Event @doc(category: "Users") {
}
"""Event sent when account is deleted."""
-type AccountDeleted implements Event @doc(category: "Users") {
+type AccountDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32068,7 +34404,7 @@ type AccountDeleted implements Event @doc(category: "Users") {
}
"""Event sent when new address is created."""
-type AddressCreated implements Event @doc(category: "Users") {
+type AddressCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32086,7 +34422,7 @@ type AddressCreated implements Event @doc(category: "Users") {
}
"""Event sent when address is updated."""
-type AddressUpdated implements Event @doc(category: "Users") {
+type AddressUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32104,7 +34440,7 @@ type AddressUpdated implements Event @doc(category: "Users") {
}
"""Event sent when address is deleted."""
-type AddressDeleted implements Event @doc(category: "Users") {
+type AddressDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32122,7 +34458,7 @@ type AddressDeleted implements Event @doc(category: "Users") {
}
"""Event sent when new app is installed."""
-type AppInstalled implements Event @doc(category: "Apps") {
+type AppInstalled implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32140,7 +34476,7 @@ type AppInstalled implements Event @doc(category: "Apps") {
}
"""Event sent when app is updated."""
-type AppUpdated implements Event @doc(category: "Apps") {
+type AppUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32158,7 +34494,7 @@ type AppUpdated implements Event @doc(category: "Apps") {
}
"""Event sent when app is deleted."""
-type AppDeleted implements Event @doc(category: "Apps") {
+type AppDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32176,7 +34512,7 @@ type AppDeleted implements Event @doc(category: "Apps") {
}
"""Event sent when app status has changed."""
-type AppStatusChanged implements Event @doc(category: "Apps") {
+type AppStatusChanged implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32194,7 +34530,7 @@ type AppStatusChanged implements Event @doc(category: "Apps") {
}
"""Event sent when new attribute is created."""
-type AttributeCreated implements Event @doc(category: "Attributes") {
+type AttributeCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32212,7 +34548,7 @@ type AttributeCreated implements Event @doc(category: "Attributes") {
}
"""Event sent when attribute is updated."""
-type AttributeUpdated implements Event @doc(category: "Attributes") {
+type AttributeUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32230,7 +34566,7 @@ type AttributeUpdated implements Event @doc(category: "Attributes") {
}
"""Event sent when attribute is deleted."""
-type AttributeDeleted implements Event @doc(category: "Attributes") {
+type AttributeDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32248,7 +34584,7 @@ type AttributeDeleted implements Event @doc(category: "Attributes") {
}
"""Event sent when new attribute value is created."""
-type AttributeValueCreated implements Event @doc(category: "Attributes") {
+type AttributeValueCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32266,7 +34602,7 @@ type AttributeValueCreated implements Event @doc(category: "Attributes") {
}
"""Event sent when attribute value is updated."""
-type AttributeValueUpdated implements Event @doc(category: "Attributes") {
+type AttributeValueUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32284,7 +34620,7 @@ type AttributeValueUpdated implements Event @doc(category: "Attributes") {
}
"""Event sent when attribute value is deleted."""
-type AttributeValueDeleted implements Event @doc(category: "Attributes") {
+type AttributeValueDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32302,7 +34638,7 @@ type AttributeValueDeleted implements Event @doc(category: "Attributes") {
}
"""Event sent when new category is created."""
-type CategoryCreated implements Event @doc(category: "Products") {
+type CategoryCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32320,7 +34656,7 @@ type CategoryCreated implements Event @doc(category: "Products") {
}
"""Event sent when category is updated."""
-type CategoryUpdated implements Event @doc(category: "Products") {
+type CategoryUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32338,7 +34674,7 @@ type CategoryUpdated implements Event @doc(category: "Products") {
}
"""Event sent when category is deleted."""
-type CategoryDeleted implements Event @doc(category: "Products") {
+type CategoryDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32356,7 +34692,7 @@ type CategoryDeleted implements Event @doc(category: "Products") {
}
"""Event sent when new channel is created."""
-type ChannelCreated implements Event @doc(category: "Channels") {
+type ChannelCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32374,7 +34710,7 @@ type ChannelCreated implements Event @doc(category: "Channels") {
}
"""Event sent when channel is updated."""
-type ChannelUpdated implements Event @doc(category: "Channels") {
+type ChannelUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32392,7 +34728,7 @@ type ChannelUpdated implements Event @doc(category: "Channels") {
}
"""Event sent when channel is deleted."""
-type ChannelDeleted implements Event @doc(category: "Channels") {
+type ChannelDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32410,7 +34746,7 @@ type ChannelDeleted implements Event @doc(category: "Channels") {
}
"""Event sent when channel status has changed."""
-type ChannelStatusChanged implements Event @doc(category: "Channels") {
+type ChannelStatusChanged implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32428,7 +34764,7 @@ type ChannelStatusChanged implements Event @doc(category: "Channels") {
}
"""Event sent when channel metadata is updated."""
-type ChannelMetadataUpdated implements Event @doc(category: "Channels") {
+type ChannelMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32446,7 +34782,7 @@ type ChannelMetadataUpdated implements Event @doc(category: "Channels") {
}
"""Event sent when new gift card is created."""
-type GiftCardCreated implements Event @doc(category: "Gift cards") {
+type GiftCardCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32464,7 +34800,7 @@ type GiftCardCreated implements Event @doc(category: "Gift cards") {
}
"""Event sent when gift card is updated."""
-type GiftCardUpdated implements Event @doc(category: "Gift cards") {
+type GiftCardUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32482,7 +34818,7 @@ type GiftCardUpdated implements Event @doc(category: "Gift cards") {
}
"""Event sent when gift card is deleted."""
-type GiftCardDeleted implements Event @doc(category: "Gift cards") {
+type GiftCardDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32500,7 +34836,7 @@ type GiftCardDeleted implements Event @doc(category: "Gift cards") {
}
"""Event sent when gift card is e-mailed."""
-type GiftCardSent implements Event @doc(category: "Gift cards") {
+type GiftCardSent implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32524,7 +34860,7 @@ type GiftCardSent implements Event @doc(category: "Gift cards") {
}
"""Event sent when gift card status has changed."""
-type GiftCardStatusChanged implements Event @doc(category: "Gift cards") {
+type GiftCardStatusChanged implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32542,7 +34878,7 @@ type GiftCardStatusChanged implements Event @doc(category: "Gift cards") {
}
"""Event sent when gift card metadata is updated."""
-type GiftCardMetadataUpdated implements Event @doc(category: "Gift cards") {
+type GiftCardMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32560,7 +34896,7 @@ type GiftCardMetadataUpdated implements Event @doc(category: "Gift cards") {
}
"""Event sent when gift card export is completed."""
-type GiftCardExportCompleted implements Event @doc(category: "Gift cards") {
+type GiftCardExportCompleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32578,7 +34914,7 @@ type GiftCardExportCompleted implements Event @doc(category: "Gift cards") {
}
"""Event sent when new menu is created."""
-type MenuCreated implements Event @doc(category: "Menu") {
+type MenuCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32599,7 +34935,7 @@ type MenuCreated implements Event @doc(category: "Menu") {
}
"""Event sent when menu is updated."""
-type MenuUpdated implements Event @doc(category: "Menu") {
+type MenuUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32620,7 +34956,7 @@ type MenuUpdated implements Event @doc(category: "Menu") {
}
"""Event sent when menu is deleted."""
-type MenuDeleted implements Event @doc(category: "Menu") {
+type MenuDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32641,7 +34977,7 @@ type MenuDeleted implements Event @doc(category: "Menu") {
}
"""Event sent when new menu item is created."""
-type MenuItemCreated implements Event @doc(category: "Menu") {
+type MenuItemCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32662,7 +34998,7 @@ type MenuItemCreated implements Event @doc(category: "Menu") {
}
"""Event sent when menu item is updated."""
-type MenuItemUpdated implements Event @doc(category: "Menu") {
+type MenuItemUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32683,7 +35019,7 @@ type MenuItemUpdated implements Event @doc(category: "Menu") {
}
"""Event sent when menu item is deleted."""
-type MenuItemDeleted implements Event @doc(category: "Menu") {
+type MenuItemDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32704,7 +35040,7 @@ type MenuItemDeleted implements Event @doc(category: "Menu") {
}
"""Event sent when new product is created."""
-type ProductCreated implements Event @doc(category: "Products") {
+type ProductCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32728,7 +35064,7 @@ type ProductCreated implements Event @doc(category: "Products") {
}
"""Event sent when product is updated."""
-type ProductUpdated implements Event @doc(category: "Products") {
+type ProductUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32752,7 +35088,7 @@ type ProductUpdated implements Event @doc(category: "Products") {
}
"""Event sent when product is deleted."""
-type ProductDeleted implements Event @doc(category: "Products") {
+type ProductDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32776,7 +35112,7 @@ type ProductDeleted implements Event @doc(category: "Products") {
}
"""Event sent when product metadata is updated."""
-type ProductMetadataUpdated implements Event @doc(category: "Products") {
+type ProductMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32800,7 +35136,7 @@ type ProductMetadataUpdated implements Event @doc(category: "Products") {
}
"""Event sent when product export is completed."""
-type ProductExportCompleted implements Event @doc(category: "Products") {
+type ProductExportCompleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32818,7 +35154,7 @@ type ProductExportCompleted implements Event @doc(category: "Products") {
}
"""Event sent when new product media is created."""
-type ProductMediaCreated implements Event @doc(category: "Products") {
+type ProductMediaCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32836,7 +35172,7 @@ type ProductMediaCreated implements Event @doc(category: "Products") {
}
"""Event sent when product media is updated."""
-type ProductMediaUpdated implements Event @doc(category: "Products") {
+type ProductMediaUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32854,7 +35190,7 @@ type ProductMediaUpdated implements Event @doc(category: "Products") {
}
"""Event sent when product media is deleted."""
-type ProductMediaDeleted implements Event @doc(category: "Products") {
+type ProductMediaDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32872,7 +35208,7 @@ type ProductMediaDeleted implements Event @doc(category: "Products") {
}
"""Event sent when new product variant is created."""
-type ProductVariantCreated implements Event @doc(category: "Products") {
+type ProductVariantCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32893,7 +35229,7 @@ type ProductVariantCreated implements Event @doc(category: "Products") {
}
"""Event sent when product variant is updated."""
-type ProductVariantUpdated implements Event @doc(category: "Products") {
+type ProductVariantUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32914,7 +35250,7 @@ type ProductVariantUpdated implements Event @doc(category: "Products") {
}
"""Event sent when product variant is out of stock."""
-type ProductVariantOutOfStock implements Event @doc(category: "Products") {
+type ProductVariantOutOfStock implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32938,7 +35274,7 @@ type ProductVariantOutOfStock implements Event @doc(category: "Products") {
}
"""Event sent when product variant is back in stock."""
-type ProductVariantBackInStock implements Event @doc(category: "Products") {
+type ProductVariantBackInStock implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32962,7 +35298,7 @@ type ProductVariantBackInStock implements Event @doc(category: "Products") {
}
"""Event sent when product variant stock is updated."""
-type ProductVariantStockUpdated implements Event @doc(category: "Products") {
+type ProductVariantStockUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -32986,7 +35322,7 @@ type ProductVariantStockUpdated implements Event @doc(category: "Products") {
}
"""Event sent when product variant is deleted."""
-type ProductVariantDeleted implements Event @doc(category: "Products") {
+type ProductVariantDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33007,7 +35343,7 @@ type ProductVariantDeleted implements Event @doc(category: "Products") {
}
"""Event sent when product variant metadata is updated."""
-type ProductVariantMetadataUpdated implements Event @doc(category: "Products") {
+type ProductVariantMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33032,7 +35368,7 @@ Event sent when new sale is created.
DEPRECATED: this event will be removed. Use `PromotionCreated` event instead.
"""
-type SaleCreated implements Event @doc(category: "Discounts") {
+type SaleCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33057,7 +35393,7 @@ Event sent when sale is updated.
DEPRECATED: this event will be removed. Use `PromotionUpdated` event instead.
"""
-type SaleUpdated implements Event @doc(category: "Discounts") {
+type SaleUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33082,7 +35418,7 @@ Event sent when sale is deleted.
DEPRECATED: this event will be removed. Use `PromotionDeleted` event instead.
"""
-type SaleDeleted implements Event @doc(category: "Discounts") {
+type SaleDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33107,7 +35443,7 @@ The event informs about the start or end of the sale.
DEPRECATED: this event will be removed. Use `PromotionStarted` and `PromotionEnded` events instead.
"""
-type SaleToggle implements Event @doc(category: "Discounts") {
+type SaleToggle implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33128,7 +35464,7 @@ type SaleToggle implements Event @doc(category: "Discounts") {
}
"""Event sent when new promotion is created."""
-type PromotionCreated implements Event @doc(category: "Discounts") {
+type PromotionCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33146,7 +35482,7 @@ type PromotionCreated implements Event @doc(category: "Discounts") {
}
"""Event sent when promotion is updated."""
-type PromotionUpdated implements Event @doc(category: "Discounts") {
+type PromotionUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33164,7 +35500,7 @@ type PromotionUpdated implements Event @doc(category: "Discounts") {
}
"""Event sent when promotion is deleted."""
-type PromotionDeleted implements Event @doc(category: "Discounts") {
+type PromotionDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33182,7 +35518,7 @@ type PromotionDeleted implements Event @doc(category: "Discounts") {
}
"""The event informs about the start of the promotion."""
-type PromotionStarted implements Event @doc(category: "Discounts") {
+type PromotionStarted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33200,7 +35536,7 @@ type PromotionStarted implements Event @doc(category: "Discounts") {
}
"""The event informs about the end of the promotion."""
-type PromotionEnded implements Event @doc(category: "Discounts") {
+type PromotionEnded implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33218,7 +35554,7 @@ type PromotionEnded implements Event @doc(category: "Discounts") {
}
"""Event sent when new promotion rule is created."""
-type PromotionRuleCreated implements Event @doc(category: "Discounts") {
+type PromotionRuleCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33236,7 +35572,7 @@ type PromotionRuleCreated implements Event @doc(category: "Discounts") {
}
"""Event sent when new promotion rule is updated."""
-type PromotionRuleUpdated implements Event @doc(category: "Discounts") {
+type PromotionRuleUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33254,7 +35590,7 @@ type PromotionRuleUpdated implements Event @doc(category: "Discounts") {
}
"""Event sent when new promotion rule is deleted."""
-type PromotionRuleDeleted implements Event @doc(category: "Discounts") {
+type PromotionRuleDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33272,7 +35608,7 @@ type PromotionRuleDeleted implements Event @doc(category: "Discounts") {
}
"""Event sent when invoice is requested."""
-type InvoiceRequested implements Event @doc(category: "Orders") {
+type InvoiceRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33293,7 +35629,7 @@ type InvoiceRequested implements Event @doc(category: "Orders") {
}
"""Event sent when invoice is deleted."""
-type InvoiceDeleted implements Event @doc(category: "Orders") {
+type InvoiceDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33314,7 +35650,7 @@ type InvoiceDeleted implements Event @doc(category: "Orders") {
}
"""Event sent when invoice is sent."""
-type InvoiceSent implements Event @doc(category: "Orders") {
+type InvoiceSent implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33335,7 +35671,7 @@ type InvoiceSent implements Event @doc(category: "Orders") {
}
"""Event sent when new fulfillment is created."""
-type FulfillmentCreated implements Event @doc(category: "Orders") {
+type FulfillmentCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33359,7 +35695,7 @@ type FulfillmentCreated implements Event @doc(category: "Orders") {
}
"""Event sent when the tracking number is updated."""
-type FulfillmentTrackingNumberUpdated implements Event @doc(category: "Orders") {
+type FulfillmentTrackingNumberUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33380,7 +35716,7 @@ type FulfillmentTrackingNumberUpdated implements Event @doc(category: "Orders")
}
"""Event sent when fulfillment is canceled."""
-type FulfillmentCanceled implements Event @doc(category: "Orders") {
+type FulfillmentCanceled implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33401,7 +35737,7 @@ type FulfillmentCanceled implements Event @doc(category: "Orders") {
}
"""Event sent when fulfillment is approved."""
-type FulfillmentApproved implements Event @doc(category: "Orders") {
+type FulfillmentApproved implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33425,7 +35761,7 @@ type FulfillmentApproved implements Event @doc(category: "Orders") {
}
"""Event sent when fulfillment metadata is updated."""
-type FulfillmentMetadataUpdated implements Event @doc(category: "Orders") {
+type FulfillmentMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33446,7 +35782,7 @@ type FulfillmentMetadataUpdated implements Event @doc(category: "Orders") {
}
"""Event sent when new customer user is created."""
-type CustomerCreated implements Event @doc(category: "Users") {
+type CustomerCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33464,7 +35800,7 @@ type CustomerCreated implements Event @doc(category: "Users") {
}
"""Event sent when customer user is updated."""
-type CustomerUpdated implements Event @doc(category: "Users") {
+type CustomerUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33482,7 +35818,7 @@ type CustomerUpdated implements Event @doc(category: "Users") {
}
"""Event sent when customer user metadata is updated."""
-type CustomerMetadataUpdated implements Event @doc(category: "Users") {
+type CustomerMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33500,7 +35836,7 @@ type CustomerMetadataUpdated implements Event @doc(category: "Users") {
}
"""Event sent when new collection is created."""
-type CollectionCreated implements Event @doc(category: "Products") {
+type CollectionCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33521,7 +35857,7 @@ type CollectionCreated implements Event @doc(category: "Products") {
}
"""Event sent when collection is updated."""
-type CollectionUpdated implements Event @doc(category: "Products") {
+type CollectionUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33542,7 +35878,7 @@ type CollectionUpdated implements Event @doc(category: "Products") {
}
"""Event sent when collection is deleted."""
-type CollectionDeleted implements Event @doc(category: "Products") {
+type CollectionDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33563,7 +35899,7 @@ type CollectionDeleted implements Event @doc(category: "Products") {
}
"""Event sent when collection metadata is updated."""
-type CollectionMetadataUpdated implements Event @doc(category: "Products") {
+type CollectionMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33584,7 +35920,7 @@ type CollectionMetadataUpdated implements Event @doc(category: "Products") {
}
"""Event sent when new page is created."""
-type PageCreated implements Event @doc(category: "Pages") {
+type PageCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33602,7 +35938,7 @@ type PageCreated implements Event @doc(category: "Pages") {
}
"""Event sent when page is updated."""
-type PageUpdated implements Event @doc(category: "Pages") {
+type PageUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33620,7 +35956,7 @@ type PageUpdated implements Event @doc(category: "Pages") {
}
"""Event sent when page is deleted."""
-type PageDeleted implements Event @doc(category: "Pages") {
+type PageDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33638,7 +35974,7 @@ type PageDeleted implements Event @doc(category: "Pages") {
}
"""Event sent when new page type is created."""
-type PageTypeCreated implements Event @doc(category: "Pages") {
+type PageTypeCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33656,7 +35992,7 @@ type PageTypeCreated implements Event @doc(category: "Pages") {
}
"""Event sent when page type is updated."""
-type PageTypeUpdated implements Event @doc(category: "Pages") {
+type PageTypeUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33674,7 +36010,7 @@ type PageTypeUpdated implements Event @doc(category: "Pages") {
}
"""Event sent when page type is deleted."""
-type PageTypeDeleted implements Event @doc(category: "Pages") {
+type PageTypeDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33692,7 +36028,7 @@ type PageTypeDeleted implements Event @doc(category: "Pages") {
}
"""Event sent when new permission group is created."""
-type PermissionGroupCreated implements Event @doc(category: "Users") {
+type PermissionGroupCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33710,7 +36046,7 @@ type PermissionGroupCreated implements Event @doc(category: "Users") {
}
"""Event sent when permission group is updated."""
-type PermissionGroupUpdated implements Event @doc(category: "Users") {
+type PermissionGroupUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33728,7 +36064,7 @@ type PermissionGroupUpdated implements Event @doc(category: "Users") {
}
"""Event sent when permission group is deleted."""
-type PermissionGroupDeleted implements Event @doc(category: "Users") {
+type PermissionGroupDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33746,7 +36082,7 @@ type PermissionGroupDeleted implements Event @doc(category: "Users") {
}
"""Event sent when new shipping price is created."""
-type ShippingPriceCreated implements Event @doc(category: "Shipping") {
+type ShippingPriceCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33773,7 +36109,7 @@ type ShippingPriceCreated implements Event @doc(category: "Shipping") {
}
"""Event sent when shipping price is updated."""
-type ShippingPriceUpdated implements Event @doc(category: "Shipping") {
+type ShippingPriceUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33800,7 +36136,7 @@ type ShippingPriceUpdated implements Event @doc(category: "Shipping") {
}
"""Event sent when shipping price is deleted."""
-type ShippingPriceDeleted implements Event @doc(category: "Shipping") {
+type ShippingPriceDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33827,7 +36163,7 @@ type ShippingPriceDeleted implements Event @doc(category: "Shipping") {
}
"""Event sent when new shipping zone is created."""
-type ShippingZoneCreated implements Event @doc(category: "Shipping") {
+type ShippingZoneCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33848,7 +36184,7 @@ type ShippingZoneCreated implements Event @doc(category: "Shipping") {
}
"""Event sent when shipping zone is updated."""
-type ShippingZoneUpdated implements Event @doc(category: "Shipping") {
+type ShippingZoneUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33869,7 +36205,7 @@ type ShippingZoneUpdated implements Event @doc(category: "Shipping") {
}
"""Event sent when shipping zone is deleted."""
-type ShippingZoneDeleted implements Event @doc(category: "Shipping") {
+type ShippingZoneDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33890,7 +36226,7 @@ type ShippingZoneDeleted implements Event @doc(category: "Shipping") {
}
"""Event sent when shipping zone metadata is updated."""
-type ShippingZoneMetadataUpdated implements Event @doc(category: "Shipping") {
+type ShippingZoneMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33929,7 +36265,7 @@ type ShopMetadataUpdated implements Event {
}
"""Event sent when new staff user is created."""
-type StaffCreated implements Event @doc(category: "Users") {
+type StaffCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33947,7 +36283,7 @@ type StaffCreated implements Event @doc(category: "Users") {
}
"""Event sent when staff user is updated."""
-type StaffUpdated implements Event @doc(category: "Users") {
+type StaffUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33965,7 +36301,7 @@ type StaffUpdated implements Event @doc(category: "Users") {
}
"""Event sent when staff user is deleted."""
-type StaffDeleted implements Event @doc(category: "Users") {
+type StaffDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -33983,7 +36319,7 @@ type StaffDeleted implements Event @doc(category: "Users") {
}
"""Event sent when setting a new password for staff is requested."""
-type StaffSetPasswordRequested implements Event @doc(category: "Users") {
+type StaffSetPasswordRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34013,7 +36349,7 @@ type StaffSetPasswordRequested implements Event @doc(category: "Users") {
}
"""Event sent when transaction item metadata is updated."""
-type TransactionItemMetadataUpdated implements Event @doc(category: "Payments") {
+type TransactionItemMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34031,7 +36367,7 @@ type TransactionItemMetadataUpdated implements Event @doc(category: "Payments")
}
"""Event sent when new translation is created."""
-type TranslationCreated implements Event @doc(category: "Miscellaneous") {
+type TranslationCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34051,7 +36387,7 @@ type TranslationCreated implements Event @doc(category: "Miscellaneous") {
union TranslationTypes = ProductTranslation | CollectionTranslation | CategoryTranslation | AttributeTranslation | AttributeValueTranslation | ProductVariantTranslation | PageTranslation | ShippingMethodTranslation | VoucherTranslation | MenuItemTranslation | PromotionTranslation | PromotionRuleTranslation | SaleTranslation
"""Event sent when translation is updated."""
-type TranslationUpdated implements Event @doc(category: "Miscellaneous") {
+type TranslationUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34069,7 +36405,7 @@ type TranslationUpdated implements Event @doc(category: "Miscellaneous") {
}
"""Event sent when new voucher is created."""
-type VoucherCreated implements Event @doc(category: "Discounts") {
+type VoucherCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34090,7 +36426,7 @@ type VoucherCreated implements Event @doc(category: "Discounts") {
}
"""Event sent when voucher is updated."""
-type VoucherUpdated implements Event @doc(category: "Discounts") {
+type VoucherUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34111,7 +36447,7 @@ type VoucherUpdated implements Event @doc(category: "Discounts") {
}
"""Event sent when voucher is deleted."""
-type VoucherDeleted implements Event @doc(category: "Discounts") {
+type VoucherDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34176,7 +36512,7 @@ type VoucherCodesDeleted implements Event {
}
"""Event sent when voucher metadata is updated."""
-type VoucherMetadataUpdated implements Event @doc(category: "Discounts") {
+type VoucherMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34201,7 +36537,7 @@ Event sent when voucher code export is completed.
Added in Saleor 3.18.
"""
-type VoucherCodeExportCompleted implements Event @doc(category: "Discounts") {
+type VoucherCodeExportCompleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34219,7 +36555,7 @@ type VoucherCodeExportCompleted implements Event @doc(category: "Discounts") {
}
"""Event sent when new warehouse is created."""
-type WarehouseCreated implements Event @doc(category: "Products") {
+type WarehouseCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34237,7 +36573,7 @@ type WarehouseCreated implements Event @doc(category: "Products") {
}
"""Event sent when warehouse is updated."""
-type WarehouseUpdated implements Event @doc(category: "Products") {
+type WarehouseUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34255,7 +36591,7 @@ type WarehouseUpdated implements Event @doc(category: "Products") {
}
"""Event sent when warehouse is deleted."""
-type WarehouseDeleted implements Event @doc(category: "Products") {
+type WarehouseDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34273,7 +36609,7 @@ type WarehouseDeleted implements Event @doc(category: "Products") {
}
"""Event sent when warehouse metadata is updated."""
-type WarehouseMetadataUpdated implements Event @doc(category: "Products") {
+type WarehouseMetadataUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34291,7 +36627,7 @@ type WarehouseMetadataUpdated implements Event @doc(category: "Products") {
}
"""Event sent when thumbnail is created."""
-type ThumbnailCreated implements Event @doc(category: "Miscellaneous") {
+type ThumbnailCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34318,7 +36654,7 @@ type ThumbnailCreated implements Event @doc(category: "Miscellaneous") {
}
"""Authorize payment."""
-type PaymentAuthorize implements Event @doc(category: "Payments") {
+type PaymentAuthorize implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34336,7 +36672,7 @@ type PaymentAuthorize implements Event @doc(category: "Payments") {
}
"""Capture payment."""
-type PaymentCaptureEvent implements Event @doc(category: "Payments") {
+type PaymentCaptureEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34354,7 +36690,7 @@ type PaymentCaptureEvent implements Event @doc(category: "Payments") {
}
"""Refund payment."""
-type PaymentRefundEvent implements Event @doc(category: "Payments") {
+type PaymentRefundEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34372,7 +36708,7 @@ type PaymentRefundEvent implements Event @doc(category: "Payments") {
}
"""Void payment."""
-type PaymentVoidEvent implements Event @doc(category: "Payments") {
+type PaymentVoidEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34390,7 +36726,7 @@ type PaymentVoidEvent implements Event @doc(category: "Payments") {
}
"""Confirm payment."""
-type PaymentConfirmEvent implements Event @doc(category: "Payments") {
+type PaymentConfirmEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34408,7 +36744,7 @@ type PaymentConfirmEvent implements Event @doc(category: "Payments") {
}
"""Process payment."""
-type PaymentProcessEvent implements Event @doc(category: "Payments") {
+type PaymentProcessEvent implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34426,7 +36762,7 @@ type PaymentProcessEvent implements Event @doc(category: "Payments") {
}
"""List payment gateways."""
-type PaymentListGateways implements Event @doc(category: "Payments") {
+type PaymentListGateways implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34444,7 +36780,7 @@ type PaymentListGateways implements Event @doc(category: "Payments") {
}
"""Event sent when transaction cancelation is requested."""
-type TransactionCancelationRequested implements Event @doc(category: "Payments") {
+type TransactionCancelationRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34464,7 +36800,7 @@ type TransactionCancelationRequested implements Event @doc(category: "Payments")
action: TransactionAction!
}
-type TransactionAction @doc(category: "Payments") {
+type TransactionAction {
"""Determines the action type."""
actionType: TransactionActionEnum!
@@ -34476,7 +36812,7 @@ type TransactionAction @doc(category: "Payments") {
}
"""Event sent when transaction charge is requested."""
-type TransactionChargeRequested implements Event @doc(category: "Payments") {
+type TransactionChargeRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34497,7 +36833,7 @@ type TransactionChargeRequested implements Event @doc(category: "Payments") {
}
"""Event sent when transaction refund is requested."""
-type TransactionRefundRequested implements Event @doc(category: "Payments") {
+type TransactionRefundRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34525,7 +36861,7 @@ type TransactionRefundRequested implements Event @doc(category: "Payments") {
}
"""Filter shipping methods for order."""
-type OrderFilterShippingMethods implements Event @doc(category: "Orders") {
+type OrderFilterShippingMethods implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34546,7 +36882,7 @@ type OrderFilterShippingMethods implements Event @doc(category: "Orders") {
}
"""Filter shipping methods for checkout."""
-type CheckoutFilterShippingMethods implements Event @doc(category: "Checkout") {
+type CheckoutFilterShippingMethods implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34567,7 +36903,7 @@ type CheckoutFilterShippingMethods implements Event @doc(category: "Checkout") {
}
"""List shipping methods for checkout."""
-type ShippingListMethodsForCheckout implements Event @doc(category: "Checkout") {
+type ShippingListMethodsForCheckout implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34588,7 +36924,7 @@ type ShippingListMethodsForCheckout implements Event @doc(category: "Checkout")
}
"""Synchronous webhook for calculating checkout/order taxes."""
-type CalculateTaxes implements Event @doc(category: "Taxes") {
+type CalculateTaxes implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34604,7 +36940,7 @@ type CalculateTaxes implements Event @doc(category: "Taxes") {
}
"""Taxable object."""
-type TaxableObject @doc(category: "Taxes") {
+type TaxableObject {
"""The source object related to this tax object."""
sourceObject: TaxSourceObject!
@@ -34631,7 +36967,7 @@ type TaxableObject @doc(category: "Taxes") {
}
"""Taxable object discount."""
-type TaxableObjectDiscount @doc(category: "Taxes") {
+type TaxableObjectDiscount {
"""The name of the discount."""
name: String
@@ -34647,12 +36983,12 @@ type TaxableObjectDiscount @doc(category: "Taxes") {
"""
Indicates which part of the order the discount should affect: SUBTOTAL or SHIPPING.
"""
-enum TaxableObjectDiscountTypeEnum @doc(category: "Taxes") {
+enum TaxableObjectDiscountTypeEnum {
SUBTOTAL
SHIPPING
}
-type TaxableObjectLine @doc(category: "Taxes") {
+type TaxableObjectLine {
"""The source line related to this tax line."""
sourceLine: TaxSourceLine!
@@ -34685,7 +37021,7 @@ type TaxableObjectLine @doc(category: "Taxes") {
union TaxSourceLine = CheckoutLine | OrderLine
"""Event sent when user wants to initialize the payment gateway."""
-type PaymentGatewayInitializeSession implements Event @doc(category: "Payments") {
+type PaymentGatewayInitializeSession implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34711,7 +37047,7 @@ type PaymentGatewayInitializeSession implements Event @doc(category: "Payments")
union OrderOrCheckout = Checkout | Order
"""Event sent when user starts processing the payment."""
-type TransactionInitializeSession implements Event @doc(category: "Payments") {
+type TransactionInitializeSession implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34748,7 +37084,7 @@ type TransactionInitializeSession implements Event @doc(category: "Payments") {
idempotencyKey: String!
}
-type TransactionProcessAction @doc(category: "Payments") {
+type TransactionProcessAction {
"""Transaction amount to process."""
amount: PositiveDecimal!
@@ -34758,7 +37094,7 @@ type TransactionProcessAction @doc(category: "Payments") {
}
"""Event sent when user has additional payment action to process."""
-type TransactionProcessSession implements Event @doc(category: "Payments") {
+type TransactionProcessSession implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34797,7 +37133,7 @@ List payment methods stored for the user by payment gateway.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
-type ListStoredPaymentMethods implements Event @doc(category: "Payments") {
+type ListStoredPaymentMethods implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34820,7 +37156,7 @@ type ListStoredPaymentMethods implements Event @doc(category: "Payments") {
}
"""Event sent when user requests to delete a payment method."""
-type StoredPaymentMethodDeleteRequested implements Event @doc(category: "Payments") {
+type StoredPaymentMethodDeleteRequested implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34848,9 +37184,9 @@ type StoredPaymentMethodDeleteRequested implements Event @doc(category: "Payment
}
"""
-Event sent to initialize a new session in payment gateway to store the payment method.
+Event sent to initialize a new session in payment gateway to store the payment method.
"""
-type PaymentGatewayInitializeTokenizationSession implements Event @doc(category: "Payments") {
+type PaymentGatewayInitializeTokenizationSession implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34874,7 +37210,7 @@ type PaymentGatewayInitializeTokenizationSession implements Event @doc(category:
}
"""Event sent when user requests a tokenization of payment method."""
-type PaymentMethodInitializeTokenizationSession implements Event @doc(category: "Payments") {
+type PaymentMethodInitializeTokenizationSession implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34901,7 +37237,7 @@ type PaymentMethodInitializeTokenizationSession implements Event @doc(category:
}
"""Event sent when user continues a tokenization of payment method."""
-type PaymentMethodProcessTokenizationSession implements Event @doc(category: "Payments") {
+type PaymentMethodProcessTokenizationSession implements Event {
"""Time of the event."""
issuedAt: DateTime
@@ -34969,7 +37305,7 @@ Represents a numeric value of an attribute.
Added in Saleor 3.22.
"""
-type AssignedNumericAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedNumericAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -34982,7 +37318,7 @@ Represents text attribute.
Added in Saleor 3.22.
"""
-type AssignedTextAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedTextAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -34998,7 +37334,7 @@ Represents plain text attribute.
Added in Saleor 3.22.
"""
-type AssignedPlainTextAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedPlainTextAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35014,7 +37350,7 @@ Represents file attribute.
Added in Saleor 3.22.
"""
-type AssignedFileAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedFileAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35027,7 +37363,7 @@ Represents a single choice attribute.
Added in Saleor 3.22.
"""
-type AssignedSingleChoiceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedSingleChoiceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35040,7 +37376,7 @@ Represents a single choice value of the attribute.
Added in Saleor 3.22.
"""
-type AssignedChoiceAttributeValue @doc(category: "Attributes") {
+type AssignedChoiceAttributeValue {
"""Name of a value displayed in the interface."""
name: String
@@ -35056,7 +37392,7 @@ Represents a multi choice attribute.
Added in Saleor 3.22.
"""
-type AssignedMultiChoiceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedMultiChoiceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35072,7 +37408,7 @@ Represents a swatch attribute.
Added in Saleor 3.22.
"""
-type AssignedSwatchAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedSwatchAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35085,8 +37421,8 @@ Represents a single swatch value.
Added in Saleor 3.22.
"""
-type AssignedSwatchAttributeValue @doc(category: "Attributes") {
- """Name of the selected swatch value."""
+type AssignedSwatchAttributeValue {
+ """Name of the selected swatch value. """
name: String
"""Slug of the selected swatch value."""
@@ -35104,7 +37440,7 @@ Represents a boolean attribute.
Added in Saleor 3.22.
"""
-type AssignedBooleanAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedBooleanAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35117,7 +37453,7 @@ Represents a date attribute.
Added in Saleor 3.22.
"""
-type AssignedDateAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedDateAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35130,7 +37466,7 @@ Represents a date time attribute.
Added in Saleor 3.22.
"""
-type AssignedDateTimeAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedDateTimeAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35143,7 +37479,7 @@ Represents single page reference attribute.
Added in Saleor 3.22.
"""
-type AssignedSinglePageReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedSinglePageReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35156,7 +37492,7 @@ Represents single product reference attribute.
Added in Saleor 3.22.
"""
-type AssignedSingleProductReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedSingleProductReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35169,7 +37505,7 @@ Represents single product variant reference attribute.
Added in Saleor 3.22.
"""
-type AssignedSingleProductVariantReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedSingleProductVariantReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35182,7 +37518,7 @@ Represents single category reference attribute.
Added in Saleor 3.22.
"""
-type AssignedSingleCategoryReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedSingleCategoryReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35195,7 +37531,7 @@ Represents single collection reference attribute.
Added in Saleor 3.22.
"""
-type AssignedSingleCollectionReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedSingleCollectionReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35208,7 +37544,7 @@ Represents multi page reference attribute.
Added in Saleor 3.22.
"""
-type AssignedMultiPageReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedMultiPageReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35224,7 +37560,7 @@ Represents multi product reference attribute.
Added in Saleor 3.22.
"""
-type AssignedMultiProductReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedMultiProductReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35240,7 +37576,7 @@ Represents multi product variant reference attribute.
Added in Saleor 3.22.
"""
-type AssignedMultiProductVariantReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedMultiProductVariantReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35258,7 +37594,7 @@ Represents multi category reference attribute.
Added in Saleor 3.22.
"""
-type AssignedMultiCategoryReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedMultiCategoryReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35274,7 +37610,7 @@ Represents multi collection reference attribute.
Added in Saleor 3.22.
"""
-type AssignedMultiCollectionReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") {
+type AssignedMultiCollectionReferenceAttribute implements AssignedAttribute {
"""Attribute assigned to an object."""
attribute: Attribute!
@@ -35294,4 +37630,4 @@ union _Entity = App | PageType | Address | User | Group | ProductVariant | Produ
"""_Service manifest as defined by Federation spec."""
type _Service {
sdl: String
-}
+}
\ No newline at end of file
diff --git a/src/configuration/createConfigurationMenu.tsx b/src/configuration/createConfigurationMenu.tsx
index cbbd017a508..caf7142c585 100644
--- a/src/configuration/createConfigurationMenu.tsx
+++ b/src/configuration/createConfigurationMenu.tsx
@@ -15,6 +15,7 @@ import { sectionNames } from "@dashboard/intl";
import { permissionGroupListUrl } from "@dashboard/permissionGroups/urls";
import { productTypeListUrl } from "@dashboard/productTypes/urls";
import { refundsSettingsPath } from "@dashboard/refundsSettings/urls";
+import { returnsSettingsPath } from "@dashboard/returnsSettings/urls";
import { shippingZonesListUrl } from "@dashboard/shipping/urls";
import { siteSettingsUrl } from "@dashboard/siteSettings/urls";
import { staffListUrl } from "@dashboard/staff/urls";
@@ -186,6 +187,17 @@ export function createConfigurationMenu(intl: IntlShape): MenuSection[] {
url: refundsSettingsPath,
testId: "configuration-menu-refunds-settings",
},
+ {
+ description: intl.formatMessage({
+ id: "9CsDlr",
+ defaultMessage: "Configure returns behavior",
+ }),
+ icon: ,
+ permissions: [PermissionEnum.MANAGE_SETTINGS],
+ title: intl.formatMessage(sectionNames.returnsSettings),
+ url: returnsSettingsPath,
+ testId: "configuration-menu-returns-settings",
+ },
],
},
];
diff --git a/src/fragments/orders.ts b/src/fragments/orders.ts
index c1b4d1cdeb4..57ff2cdcc97 100644
--- a/src/fragments/orders.ts
+++ b/src/fragments/orders.ts
@@ -288,6 +288,11 @@ export const fulfillmentFragment = gql`
orderLine {
...OrderLine
}
+ reason
+ reasonReference {
+ id
+ title
+ }
}
fulfillmentOrder
status
@@ -296,6 +301,11 @@ export const fulfillmentFragment = gql`
id
name
}
+ reason
+ reasonReference {
+ id
+ title
+ }
}
`;
@@ -796,6 +806,11 @@ export const fragmentOrderGrantedRefunds = gql`
orderLine {
id
}
+ reason
+ reasonReference {
+ id
+ title
+ }
}
}
`;
@@ -838,6 +853,10 @@ export const orderDetailsGrantedRefund = gql`
id
quantity
reason
+ reasonReference {
+ id
+ title
+ }
orderLine {
...OrderLine
}
diff --git a/src/graphql/fabbrica.generated.ts b/src/graphql/fabbrica.generated.ts
index 426904c2fcf..d7050b21dff 100644
--- a/src/graphql/fabbrica.generated.ts
+++ b/src/graphql/fabbrica.generated.ts
@@ -64,6 +64,17 @@ import type {
AppManifestExtension,
AppManifestRequiredSaleorVersion,
AppManifestWebhook,
+ AppProblem,
+ AppProblemCreate,
+ AppProblemCreateError,
+ AppProblemCreateInput,
+ AppProblemDismiss,
+ AppProblemDismissByAppInput,
+ AppProblemDismissByStaffWithIdsInput,
+ AppProblemDismissByStaffWithKeysInput,
+ AppProblemDismissError,
+ AppProblemDismissInput,
+ AppProblemDismissed,
AppReenableSyncWebhooks,
AppRetryInstall,
AppSortingInput,
@@ -900,6 +911,12 @@ import type {
ReorderInput,
RequestEmailChange,
RequestPasswordReset,
+ ReturnReasonReferenceTypeClear,
+ ReturnReasonReferenceTypeClearError,
+ ReturnSettings,
+ ReturnSettingsUpdate,
+ ReturnSettingsUpdateError,
+ ReturnSettingsUpdateInput,
Sale,
SaleAddCatalogues,
SaleBulkDelete,
@@ -1060,6 +1077,8 @@ import type {
TransactionAction,
TransactionCancelationRequested,
TransactionChargeRequested,
+ TransactionCountableConnection,
+ TransactionCountableEdge,
TransactionCreate,
TransactionCreateError,
TransactionCreateInput,
@@ -1085,6 +1104,7 @@ import type {
TransactionUpdate,
TransactionUpdateError,
TransactionUpdateInput,
+ TransactionWhereInput,
TranslatableItemConnection,
TranslatableItemEdge,
TranslationCreated,
@@ -2237,6 +2257,14 @@ export type OptionalApp = {
privateMetafield?: App['privateMetafield'] | undefined;
/** Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. */
privateMetafields?: App['privateMetafields'] | undefined;
+ /**
+ * List of problems associated with this app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP, MANAGE_APPS.
+ */
+ problems?: Maybe | undefined;
/** Support page for the app. */
supportUrl?: App['supportUrl'] | undefined;
/**
@@ -2616,7 +2644,11 @@ export const defineAppExtensionCountableEdgeFactory: DefineTypeFactoryInterface<
export type OptionalAppExtensionFilterInput = {
__typename?: 'AppExtensionFilterInput';
- /** DEPRECATED: Use `mountName` instead. */
+ /**
+ * DEPRECATED: Use `mountName` instead.
+ *
+ * DEPRECATED: this field will be removed.
+ */
mount?: AppExtensionFilterInput['mount'] | undefined;
/**
* Plain-text mount name (case insensitive)
@@ -2624,7 +2656,11 @@ export type OptionalAppExtensionFilterInput = {
* Added in Saleor 3.22.
*/
mountName?: AppExtensionFilterInput['mountName'] | undefined;
- /** DEPRECATED: Use `targetName` instead. */
+ /**
+ * DEPRECATED: Use `targetName` instead.
+ *
+ * DEPRECATED: this field will be removed.
+ */
target?: AppExtensionFilterInput['target'] | undefined;
/**
* Plain-text target name (case insensitive)
@@ -2973,6 +3009,311 @@ export const defineAppManifestWebhookFactory: DefineTypeFactoryInterface<
{}
> = defineTypeFactory;
+/**
+ * Represents a problem associated with an app.
+ *
+ * Added in Saleor 3.22.
+ */
+export type OptionalAppProblem = {
+ __typename?: 'AppProblem';
+ /**
+ * Number of occurrences.
+ *
+ * Added in Saleor 3.22.
+ */
+ count?: AppProblem['count'] | undefined;
+ /**
+ * The date and time when the problem was created.
+ *
+ * Added in Saleor 3.22.
+ */
+ createdAt?: AppProblem['createdAt'] | undefined;
+ /**
+ * Dismissal information. Null if the problem has not been dismissed.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP, MANAGE_APPS.
+ */
+ dismissed?: Maybe | undefined;
+ /**
+ * The ID of the app problem.
+ *
+ * Added in Saleor 3.22.
+ */
+ id?: AppProblem['id'] | undefined;
+ /**
+ * Whether the problem has reached critical threshold.
+ *
+ * Added in Saleor 3.22.
+ */
+ isCritical?: AppProblem['isCritical'] | undefined;
+ /**
+ * Key identifying the type of problem.
+ *
+ * Added in Saleor 3.22.
+ */
+ key?: AppProblem['key'] | undefined;
+ /**
+ * The problem message.
+ *
+ * Added in Saleor 3.22.
+ */
+ message?: AppProblem['message'] | undefined;
+ /**
+ * The date and time when the problem was last updated.
+ *
+ * Added in Saleor 3.22.
+ */
+ updatedAt?: AppProblem['updatedAt'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblem} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemFactoryInterface}
+ */
+export const defineAppProblemFactory: DefineTypeFactoryInterface<
+ OptionalAppProblem,
+ {}
+> = defineTypeFactory;
+
+/**
+ * Add a problem to the calling app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP.
+ */
+export type OptionalAppProblemCreate = {
+ __typename?: 'AppProblemCreate';
+ /** The created or updated app problem. */
+ appProblem?: Maybe | undefined;
+ errors?: OptionalAppProblemCreateError[] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemCreate} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemCreateFactoryInterface}
+ */
+export const defineAppProblemCreateFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemCreate,
+ {}
+> = defineTypeFactory;
+
+export type OptionalAppProblemCreateError = {
+ __typename?: 'AppProblemCreateError';
+ /** The error code. */
+ code?: AppProblemCreateError['code'] | undefined;
+ /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */
+ field?: AppProblemCreateError['field'] | undefined;
+ /** The error message. */
+ message?: AppProblemCreateError['message'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemCreateError} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemCreateErrorFactoryInterface}
+ */
+export const defineAppProblemCreateErrorFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemCreateError,
+ {}
+> = defineTypeFactory;
+
+export type OptionalAppProblemCreateInput = {
+ __typename?: 'AppProblemCreateInput';
+ /** Time window in minutes for aggregating problems with the same key. Defaults to 60. If 0, a new problem is always created. */
+ aggregationPeriod?: AppProblemCreateInput['aggregationPeriod'] | undefined;
+ /** If set, the problem becomes critical when count reaches this value. If sent again with higher value than already counted, problem can be de-escalated. */
+ criticalThreshold?: AppProblemCreateInput['criticalThreshold'] | undefined;
+ /** Key identifying the type of problem. App can add multiple problems under the same key, to merge them together or delete them in batch. Must be between 3 and 128 characters. */
+ key?: AppProblemCreateInput['key'] | undefined;
+ /** The problem message to display. Must be at least 3 characters. Messages longer than 2048 characters will be truncated to 2048 characters with '...' suffix. */
+ message?: AppProblemCreateInput['message'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemCreateInput} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemCreateInputFactoryInterface}
+ */
+export const defineAppProblemCreateInputFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemCreateInput,
+ {}
+> = defineTypeFactory;
+
+/**
+ * Dismiss problems for an app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
+ */
+export type OptionalAppProblemDismiss = {
+ __typename?: 'AppProblemDismiss';
+ errors?: OptionalAppProblemDismissError[] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemDismiss} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemDismissFactoryInterface}
+ */
+export const defineAppProblemDismissFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemDismiss,
+ {}
+> = defineTypeFactory;
+
+/** Input for app callers to dismiss their own problems. */
+export type OptionalAppProblemDismissByAppInput = {
+ __typename?: 'AppProblemDismissByAppInput';
+ /** List of problem IDs to dismiss. Cannot be combined with keys. Max 100. */
+ ids?: AppProblemDismissByAppInput['ids'] | undefined;
+ /** List of problem keys to dismiss. Cannot be combined with ids. Max 100. */
+ keys?: AppProblemDismissByAppInput['keys'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemDismissByAppInput} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemDismissByAppInputFactoryInterface}
+ */
+export const defineAppProblemDismissByAppInputFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemDismissByAppInput,
+ {}
+> = defineTypeFactory;
+
+/** Input for staff callers to dismiss problems by IDs. */
+export type OptionalAppProblemDismissByStaffWithIdsInput = {
+ __typename?: 'AppProblemDismissByStaffWithIdsInput';
+ /** List of problem IDs to dismiss. Max 100. */
+ ids?: AppProblemDismissByStaffWithIdsInput['ids'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemDismissByStaffWithIdsInput} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemDismissByStaffWithIdsInputFactoryInterface}
+ */
+export const defineAppProblemDismissByStaffWithIdsInputFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemDismissByStaffWithIdsInput,
+ {}
+> = defineTypeFactory;
+
+/** Input for staff callers to dismiss problems by keys. */
+export type OptionalAppProblemDismissByStaffWithKeysInput = {
+ __typename?: 'AppProblemDismissByStaffWithKeysInput';
+ /** ID of the app whose problems to dismiss. */
+ app?: AppProblemDismissByStaffWithKeysInput['app'] | undefined;
+ /** List of problem keys to dismiss. Max 100. */
+ keys?: AppProblemDismissByStaffWithKeysInput['keys'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemDismissByStaffWithKeysInput} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemDismissByStaffWithKeysInputFactoryInterface}
+ */
+export const defineAppProblemDismissByStaffWithKeysInputFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemDismissByStaffWithKeysInput,
+ {}
+> = defineTypeFactory;
+
+export type OptionalAppProblemDismissError = {
+ __typename?: 'AppProblemDismissError';
+ /** The error code. */
+ code?: AppProblemDismissError['code'] | undefined;
+ /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */
+ field?: AppProblemDismissError['field'] | undefined;
+ /** The error message. */
+ message?: AppProblemDismissError['message'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemDismissError} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemDismissErrorFactoryInterface}
+ */
+export const defineAppProblemDismissErrorFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemDismissError,
+ {}
+> = defineTypeFactory;
+
+/** Input for dismissing app problems. Only one can be specified. */
+export type OptionalAppProblemDismissInput = {
+ __typename?: 'AppProblemDismissInput';
+ /** For app callers only - dismiss own problems. */
+ byApp?: Maybe | undefined;
+ /** For staff callers - dismiss problems by IDs. */
+ byStaffWithIds?: Maybe | undefined;
+ /** For staff callers - dismiss problems by keys for specified app. */
+ byStaffWithKeys?: Maybe | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemDismissInput} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemDismissInputFactoryInterface}
+ */
+export const defineAppProblemDismissInputFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemDismissInput,
+ {}
+> = defineTypeFactory;
+
+/**
+ * Dismissal information for an app problem.
+ *
+ * Added in Saleor 3.22.
+ */
+export type OptionalAppProblemDismissed = {
+ __typename?: 'AppProblemDismissed';
+ /**
+ * Whether the problem was dismissed by an App or a User.
+ *
+ * Added in Saleor 3.22.
+ */
+ by?: AppProblemDismissed['by'] | undefined;
+ /**
+ * The user who dismissed this problem. Null if dismissed by an app or the user was deleted.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_STAFF.
+ */
+ user?: Maybe | undefined;
+ /**
+ * Email of the user who dismissed this problem. Preserved even if the user is deleted.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
+ */
+ userEmail?: AppProblemDismissed['userEmail'] | undefined;
+};
+
+/**
+ * Define factory for {@link AppProblemDismissed} model.
+ *
+ * @param options
+ * @returns factory {@link AppProblemDismissedFactoryInterface}
+ */
+export const defineAppProblemDismissedFactory: DefineTypeFactoryInterface<
+ OptionalAppProblemDismissed,
+ {}
+> = defineTypeFactory;
+
/**
* Re-enable sync webhooks for provided app. Can be used to manually re-enable sync webhooks for the app before the cooldown period ends.
*
@@ -3832,7 +4173,7 @@ export type OptionalAssignedSwatchAttributeValue = {
file?: Maybe | undefined;
/** Hex color code. */
hexColor?: AssignedSwatchAttributeValue['hexColor'] | undefined;
- /** Name of the selected swatch value. */
+ /** Name of the selected swatch value. */
name?: AssignedSwatchAttributeValue['name'] | undefined;
/** Slug of the selected swatch value. */
slug?: AssignedSwatchAttributeValue['slug'] | undefined;
@@ -4335,7 +4676,11 @@ export const defineAttributeCreateFactory: DefineTypeFactoryInterface<
*/
export type OptionalAttributeCreateInput = {
__typename?: 'AttributeCreateInput';
- /** Whether the attribute can be displayed in the admin product list. */
+ /**
+ * Whether the attribute can be displayed in the admin product list.
+ *
+ * DEPRECATED: this field will be removed.
+ */
availableInGrid?: AttributeCreateInput['availableInGrid'] | undefined;
/** The entity type which can be used as a reference. */
entityType?: AttributeCreateInput['entityType'] | undefined;
@@ -4343,7 +4688,11 @@ export type OptionalAttributeCreateInput = {
externalReference?: AttributeCreateInput['externalReference'] | undefined;
/** Whether the attribute can be filtered in dashboard. */
filterableInDashboard?: AttributeCreateInput['filterableInDashboard'] | undefined;
- /** Whether the attribute can be filtered in storefront. */
+ /**
+ * Whether the attribute can be filtered in storefront.
+ *
+ * DEPRECATED: this field will be removed.
+ */
filterableInStorefront?: AttributeCreateInput['filterableInStorefront'] | undefined;
/** The input type to use for entering attribute values in the dashboard. */
inputType?: AttributeCreateInput['inputType'] | undefined;
@@ -4361,7 +4710,11 @@ export type OptionalAttributeCreateInput = {
referenceTypes?: AttributeCreateInput['referenceTypes'] | undefined;
/** Internal representation of an attribute name. */
slug?: AttributeCreateInput['slug'] | undefined;
- /** The position of the attribute in the storefront navigation (0 by default). */
+ /**
+ * The position of the attribute in the storefront navigation (0 by default).
+ *
+ * DEPRECATED: this field will be removed.
+ */
storefrontSearchPosition?: AttributeCreateInput['storefrontSearchPosition'] | undefined;
/** The attribute type. */
type?: AttributeCreateInput['type'] | undefined;
@@ -4507,7 +4860,11 @@ export const defineAttributeErrorFactory: DefineTypeFactoryInterface<
export type OptionalAttributeFilterInput = {
__typename?: 'AttributeFilterInput';
availableInGrid?: AttributeFilterInput['availableInGrid'] | undefined;
- /** Specifies the channel by which the data should be filtered. */
+ /**
+ * Specifies the channel by which the data should be filtered.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: AttributeFilterInput['channel'] | undefined;
filterableInDashboard?: AttributeFilterInput['filterableInDashboard'] | undefined;
filterableInStorefront?: AttributeFilterInput['filterableInStorefront'] | undefined;
@@ -4536,19 +4893,39 @@ export const defineAttributeFilterInputFactory: DefineTypeFactoryInterface<
export type OptionalAttributeInput = {
__typename?: 'AttributeInput';
- /** The boolean value of the attribute. Requires `slug` to be provided. */
+ /**
+ * The boolean value of the attribute. Requires `slug` to be provided.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
+ */
boolean?: AttributeInput['boolean'] | undefined;
- /** 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. Requires `slug` to be provided. */
+ /**
+ * 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. Requires `slug` to be provided.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
+ */
date?: Maybe | undefined;
- /** The date/time range that the returned values should be in. Requires `slug` to be provided. */
+ /**
+ * The date/time range that the returned values should be in. Requires `slug` to be provided.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
+ */
dateTime?: Maybe | undefined;
/** Internal representation of an attribute name. */
slug?: AttributeInput['slug'] | undefined;
- /** Filter by value of the attribute. Only one value input field is allowed. If provided more than one, the error will be raised. Cannot be combined with deprecated fields of `AttributeInput`. */
+ /** Filter by value of the attribute. Only one value input field is allowed. If provided more than one, the error will be raised. Cannot be combined with deprecated fields of `AttributeInput`. */
value?: Maybe | undefined;
- /** Slugs identifying the attributeValues associated with the Attribute. When specified, it filters the results to include only records with one of the matching values. Requires `slug` to be provided. */
+ /**
+ * Slugs identifying the attributeValues associated with the Attribute. When specified, it filters the results to include only records with one of the matching values. Requires `slug` to be provided.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
+ */
values?: AttributeInput['values'] | undefined;
- /** The range that the returned values should be in. Requires `slug` to be provided. */
+ /**
+ * The range that the returned values should be in. Requires `slug` to be provided.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
+ */
valuesRange?: Maybe | undefined;
};
@@ -4757,13 +5134,21 @@ export type OptionalAttributeUpdateInput = {
__typename?: 'AttributeUpdateInput';
/** New values to be created for this attribute. */
addValues?: Maybe | undefined;
- /** Whether the attribute can be displayed in the admin product list. */
+ /**
+ * Whether the attribute can be displayed in the admin product list.
+ *
+ * DEPRECATED: this field will be removed.
+ */
availableInGrid?: AttributeUpdateInput['availableInGrid'] | undefined;
/** External ID of this product. */
externalReference?: AttributeUpdateInput['externalReference'] | undefined;
/** Whether the attribute can be filtered in dashboard. */
filterableInDashboard?: AttributeUpdateInput['filterableInDashboard'] | undefined;
- /** Whether the attribute can be filtered in storefront. */
+ /**
+ * Whether the attribute can be filtered in storefront.
+ *
+ * DEPRECATED: this field will be removed.
+ */
filterableInStorefront?: AttributeUpdateInput['filterableInStorefront'] | undefined;
/** Whether the attribute is for variants only. */
isVariantOnly?: AttributeUpdateInput['isVariantOnly'] | undefined;
@@ -4781,7 +5166,11 @@ export type OptionalAttributeUpdateInput = {
removeValues?: AttributeUpdateInput['removeValues'] | undefined;
/** Internal representation of an attribute name. */
slug?: AttributeUpdateInput['slug'] | undefined;
- /** The position of the attribute in the storefront navigation (0 by default). */
+ /**
+ * The position of the attribute in the storefront navigation (0 by default).
+ *
+ * DEPRECATED: this field will be removed.
+ */
storefrontSearchPosition?: AttributeUpdateInput['storefrontSearchPosition'] | undefined;
/** The unit of attribute values. */
unit?: AttributeUpdateInput['unit'] | undefined;
@@ -5070,12 +5459,18 @@ export type OptionalAttributeValueCreateInput = {
fileUrl?: AttributeValueCreateInput['fileUrl'] | undefined;
/** Name of a value displayed in the interface. */
name?: AttributeValueCreateInput['name'] | undefined;
- /** Represents the text of the attribute value, plain text without formatting. */
+ /**
+ * Represents the text of the attribute value, plain text without formatting.
+ *
+ * DEPRECATED: this field will be removed.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
+ */
plainText?: AttributeValueCreateInput['plainText'] | undefined;
/**
* Represents the text of the attribute value, includes formatting.
*
* Rich text format. For reference see https://editorjs.io/
+ *
+ * DEPRECATED: this field will be removed.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
*/
richText?: AttributeValueCreateInput['richText'] | undefined;
/** Represent value of the attribute value (e.g. color values for swatch attributes). */
@@ -5228,7 +5623,11 @@ export type OptionalAttributeValueInput = {
richText?: AttributeValueInput['richText'] | undefined;
/** Attribute value ID or external reference. */
swatch?: Maybe | undefined;
- /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. */
+ /**
+ * The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
+ *
+ * DEPRECATED: this field will be removed.
+ */
values?: AttributeValueInput['values'] | undefined;
};
@@ -5425,12 +5824,18 @@ export type OptionalAttributeValueUpdateInput = {
fileUrl?: AttributeValueUpdateInput['fileUrl'] | undefined;
/** Name of a value displayed in the interface. */
name?: AttributeValueUpdateInput['name'] | undefined;
- /** Represents the text of the attribute value, plain text without formatting. */
+ /**
+ * Represents the text of the attribute value, plain text without formatting.
+ *
+ * DEPRECATED: this field will be removed.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
+ */
plainText?: AttributeValueUpdateInput['plainText'] | undefined;
/**
* Represents the text of the attribute value, includes formatting.
*
* Rich text format. For reference see https://editorjs.io/
+ *
+ * DEPRECATED: this field will be removed.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
*/
richText?: AttributeValueUpdateInput['richText'] | undefined;
/** Represent value of the attribute value (e.g. color values for swatch attributes). */
@@ -5567,7 +5972,11 @@ export type OptionalBulkAttributeValueInput = {
richText?: BulkAttributeValueInput['richText'] | undefined;
/** Attribute value ID. */
swatch?: Maybe | undefined;
- /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. */
+ /**
+ * The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
+ *
+ * DEPRECATED: this field will be removed.
+ */
values?: BulkAttributeValueInput['values'] | undefined;
};
@@ -6096,7 +6505,11 @@ export const defineCategoryInputFactory: DefineTypeFactoryInterface<
export type OptionalCategorySortingInput = {
__typename?: 'CategorySortingInput';
- /** Specifies the channel in which to sort the data. */
+ /**
+ * Specifies the channel in which to sort the data.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: CategorySortingInput['channel'] | undefined;
/** Specifies the direction in which to sort categories. */
direction?: CategorySortingInput['direction'] | undefined;
@@ -7845,7 +8258,7 @@ export const defineCheckoutLineDeleteFactory: DefineTypeFactoryInterface<
export type OptionalCheckoutLineInput = {
__typename?: 'CheckoutLineInput';
- /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
+ /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
forceNewLine?: CheckoutLineInput['forceNewLine'] | undefined;
/**
* Fields required to update the object's metadata. Can be read by any API client authorized to read the object it's attached to.
@@ -7931,7 +8344,11 @@ export type OptionalCheckoutLineUpdateInput = {
price?: CheckoutLineUpdateInput['price'] | undefined;
/** The number of items purchased. Optional for apps, required for any other users. */
quantity?: CheckoutLineUpdateInput['quantity'] | undefined;
- /** ID of the product variant. */
+ /**
+ * ID of the product variant.
+ *
+ * DEPRECATED: this field will be removed. Use `lineId` instead.
+ */
variantId?: CheckoutLineUpdateInput['variantId'] | undefined;
};
@@ -8117,7 +8534,11 @@ export type OptionalCheckoutSettings = {
* Added in Saleor 3.20.
*/
automaticallyCompleteFullyPaidCheckouts?: CheckoutSettings['automaticallyCompleteFullyPaidCheckouts'] | undefined;
- /** Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one. */
+ /**
+ * Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
+ *
+ * DEPRECATED: this field will be removed.
+ */
useLegacyErrorFlow?: CheckoutSettings['useLegacyErrorFlow'] | undefined;
};
@@ -8144,9 +8565,15 @@ export type OptionalCheckoutSettingsInput = {
* Default `false`. Determines if the paid checkouts should be automatically completed. This setting applies only to checkouts where payment was processed through transactions.When enabled, the checkout will be automatically completed once the checkout `authorize_status` reaches `FULL`. This occurs when the total sum of charged and authorized transaction amounts equals or exceeds the checkout's total amount.
*
* Added in Saleor 3.20.
+ *
+ * DEPRECATED: this field will be removed. Use `automatic_completion` instead.
*/
automaticallyCompleteFullyPaidCheckouts?: CheckoutSettingsInput['automaticallyCompleteFullyPaidCheckouts'] | undefined;
- /** Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one. */
+ /**
+ * Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
+ *
+ * DEPRECATED: this field will be removed.
+ */
useLegacyErrorFlow?: CheckoutSettingsInput['useLegacyErrorFlow'] | undefined;
};
@@ -8603,7 +9030,11 @@ export type OptionalCollectionCreateInput = {
privateMetadata?: Maybe | undefined;
/** List of products to be added to the collection. */
products?: CollectionCreateInput['products'] | undefined;
- /** Publication date. ISO 8601 standard. */
+ /**
+ * Publication date. ISO 8601 standard.
+ *
+ * DEPRECATED: this field will be removed.
+ */
publicationDate?: CollectionCreateInput['publicationDate'] | undefined;
/** Search engine optimization fields. */
seo?: Maybe | undefined;
@@ -8722,7 +9153,11 @@ export const defineCollectionErrorFactory: DefineTypeFactoryInterface<
export type OptionalCollectionFilterInput = {
__typename?: 'CollectionFilterInput';
- /** Specifies the channel by which the data should be filtered. */
+ /**
+ * Specifies the channel by which the data should be filtered.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: CollectionFilterInput['channel'] | undefined;
ids?: CollectionFilterInput['ids'] | undefined;
metadata?: Maybe | undefined;
@@ -8770,7 +9205,11 @@ export type OptionalCollectionInput = {
* Warning: never store sensitive information, including financial data such as credit card details.
*/
privateMetadata?: Maybe | undefined;
- /** Publication date. ISO 8601 standard. */
+ /**
+ * Publication date. ISO 8601 standard.
+ *
+ * DEPRECATED: this field will be removed.
+ */
publicationDate?: CollectionInput['publicationDate'] | undefined;
/** Search engine optimization fields. */
seo?: Maybe | undefined;
@@ -8865,7 +9304,11 @@ export const defineCollectionReorderProductsFactory: DefineTypeFactoryInterface<
export type OptionalCollectionSortingInput = {
__typename?: 'CollectionSortingInput';
- /** Specifies the channel in which to sort the data. */
+ /**
+ * Specifies the channel in which to sort the data.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: CollectionSortingInput['channel'] | undefined;
/** Specifies the direction in which to sort collections. */
direction?: CollectionSortingInput['direction'] | undefined;
@@ -10382,7 +10825,11 @@ export type OptionalDraftOrderCreateInput = {
channelId?: DraftOrderCreateInput['channelId'] | undefined;
/** A note from a customer. Visible by customers in the order summary. */
customerNote?: DraftOrderCreateInput['customerNote'] | undefined;
- /** Discount amount for the order. */
+ /**
+ * Discount amount for the order.
+ *
+ * DEPRECATED: this field will be removed. Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
+ */
discount?: DraftOrderCreateInput['discount'] | undefined;
/** External ID of this order. */
externalReference?: DraftOrderCreateInput['externalReference'] | undefined;
@@ -10536,7 +10983,11 @@ export type OptionalDraftOrderInput = {
channelId?: DraftOrderInput['channelId'] | undefined;
/** A note from a customer. Visible by customers in the order summary. */
customerNote?: DraftOrderInput['customerNote'] | undefined;
- /** Discount amount for the order. */
+ /**
+ * Discount amount for the order.
+ *
+ * DEPRECATED: this field will be removed. Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
+ */
discount?: DraftOrderInput['discount'] | undefined;
/** External ID of this order. */
externalReference?: DraftOrderInput['externalReference'] | undefined;
@@ -11564,6 +12015,18 @@ export type OptionalFulfillment = {
privateMetafield?: Fulfillment['privateMetafield'] | undefined;
/** Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. */
privateMetafields?: Fulfillment['privateMetafields'] | undefined;
+ /**
+ * Reason for the fulfillment action.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason?: Fulfillment['reason'] | undefined;
+ /**
+ * Reason Model (Page) reference for this fulfillment.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: Maybe | undefined;
/** Amount of refunded shipping price. */
shippingRefundedAmount?: Maybe | undefined;
/** Status of fulfillment. */
@@ -11780,6 +12243,18 @@ export type OptionalFulfillmentLine = {
orderLine?: Maybe | undefined;
/** The number of items included in the fulfillment line. */
quantity?: FulfillmentLine['quantity'] | undefined;
+ /**
+ * Reason for the fulfillment line action.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason?: FulfillmentLine['reason'] | undefined;
+ /**
+ * Reason Model (Page) reference for this fulfillment line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: Maybe | undefined;
};
/**
@@ -12390,9 +12865,17 @@ export type OptionalGiftCardCreateInput = {
balance?: OptionalPriceInput | undefined;
/** Slug of a channel from which the email should be sent. */
channel?: GiftCardCreateInput['channel'] | undefined;
- /** Code to use the gift card. */
+ /**
+ * Code to use the gift card.
+ *
+ * DEPRECATED: this field will be removed. The code is now auto generated.
+ */
code?: GiftCardCreateInput['code'] | undefined;
- /** End date of the gift card in ISO 8601 format. */
+ /**
+ * End date of the gift card in ISO 8601 format.
+ *
+ * DEPRECATED: this field will be removed. Use `expiryDate` from `expirySettings` instead.
+ */
endDate?: GiftCardCreateInput['endDate'] | undefined;
/** The gift card expiry date. */
expiryDate?: GiftCardCreateInput['expiryDate'] | undefined;
@@ -12416,7 +12899,11 @@ export type OptionalGiftCardCreateInput = {
* Warning: never store sensitive information, including financial data such as credit card details.
*/
privateMetadata?: Maybe | undefined;
- /** Start date of the gift card in ISO 8601 format. */
+ /**
+ * Start date of the gift card in ISO 8601 format.
+ *
+ * DEPRECATED: this field will be removed.
+ */
startDate?: GiftCardCreateInput['startDate'] | undefined;
/** Email of the customer to whom gift card will be sent. */
userEmail?: GiftCardCreateInput['userEmail'] | undefined;
@@ -13035,7 +13522,11 @@ export type OptionalGiftCardUpdateInput = {
addTags?: GiftCardUpdateInput['addTags'] | undefined;
/** The gift card balance amount. */
balanceAmount?: GiftCardUpdateInput['balanceAmount'] | undefined;
- /** End date of the gift card in ISO 8601 format. */
+ /**
+ * End date of the gift card in ISO 8601 format.
+ *
+ * DEPRECATED: this field will be removed. Use `expiryDate` from `expirySettings` instead.
+ */
endDate?: GiftCardUpdateInput['endDate'] | undefined;
/** The gift card expiry date. */
expiryDate?: GiftCardUpdateInput['expiryDate'] | undefined;
@@ -13057,7 +13548,11 @@ export type OptionalGiftCardUpdateInput = {
privateMetadata?: Maybe | undefined;
/** The gift card tags to remove. */
removeTags?: GiftCardUpdateInput['removeTags'] | undefined;
- /** Start date of the gift card in ISO 8601 format. */
+ /**
+ * Start date of the gift card in ISO 8601 format.
+ *
+ * DEPRECATED: this field will be removed.
+ */
startDate?: GiftCardUpdateInput['startDate'] | undefined;
};
@@ -14765,6 +15260,7 @@ export const defineMetadataFilterFactory: DefineTypeFactoryInterface<
* Matches objects where the metadata key "color" is set to either "blue" or "green".
* - `{key: "status", value: {eq: "active"}}`
* Matches objects where the metadata key "status" is set to "active".
+ *
*/
export type OptionalMetadataFilterInput = {
__typename?: 'MetadataFilterInput';
@@ -15083,6 +15579,22 @@ export type OptionalMutation = {
/** Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. */
appInstall?: Maybe | undefined;
/**
+ * Add a problem to the calling app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP.
+ */
+ appProblemCreate?: Maybe | undefined;
+ /**
+ * Dismiss problems for an app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
+ */
+ appProblemDismiss?: Maybe | undefined;
+ /**
* Re-enable sync webhooks for provided app. Can be used to manually re-enable sync webhooks for the app before the cooldown period ends.
*
* Added in Saleor 3.21.
@@ -16712,6 +17224,22 @@ export type OptionalMutation = {
*/
requestPasswordReset?: Maybe | undefined;
/**
+ * Updates ReturnSettings. The `Page` (Model) Type will be cleared from `reasonReferenceType`. When it's cleared, passing reason reference to return mutations is no longer accepted and will raise error.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_SETTINGS.
+ */
+ returnReasonReferenceClear?: Maybe | undefined;
+ /**
+ * Update return settings across all channels.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_SETTINGS.
+ */
+ returnSettingsUpdate?: Maybe | undefined;
+ /**
* Deletes sales.
*
* Requires one of the following permissions: MANAGE_DISCOUNTS.
@@ -17042,7 +17570,7 @@ export type OptionalMutation = {
transactionEventReport?: Maybe | undefined;
/** Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. There is a limit of 100 transaction items per checkout / order. */
transactionInitialize?: Maybe | undefined;
- /** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */
+ /** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */
transactionProcess?: Maybe | undefined;
/**
* Request an action for payment transaction.
@@ -17276,7 +17804,7 @@ export const defineNewTabTargetOptionsFactory: DefineTypeFactoryInterface<
> = defineTypeFactory;
/** An object with an ID */
-export type OptionalNode = OptionalAddress | OptionalAllocation | OptionalApp | OptionalAppExtension | OptionalAppInstallation | OptionalAppToken | OptionalAttribute | OptionalAttributeTranslatableContent | OptionalAttributeTranslation | OptionalAttributeValue | OptionalAttributeValueTranslatableContent | OptionalAttributeValueTranslation | OptionalCategory | OptionalCategoryTranslatableContent | OptionalCategoryTranslation | OptionalChannel | OptionalCheckout | OptionalCheckoutLine | OptionalCollection | OptionalCollectionChannelListing | OptionalCollectionTranslatableContent | OptionalCollectionTranslation | OptionalCustomerEvent | OptionalDigitalContent | OptionalDigitalContentUrl | OptionalEventDelivery | OptionalEventDeliveryAttempt | OptionalExportEvent | OptionalExportFile | OptionalFulfillment | OptionalFulfillmentLine | OptionalGiftCard | OptionalGiftCardEvent | OptionalGiftCardTag | OptionalGroup | OptionalInvoice | OptionalMenu | OptionalMenuItem | OptionalMenuItemTranslatableContent | OptionalMenuItemTranslation | OptionalOrder | OptionalOrderDiscount | OptionalOrderEvent | OptionalOrderLine | OptionalPage | OptionalPageTranslatableContent | OptionalPageTranslation | OptionalPageType | OptionalPayment | OptionalProduct | OptionalProductChannelListing | OptionalProductMedia | OptionalProductTranslatableContent | OptionalProductTranslation | OptionalProductType | OptionalProductVariant | OptionalProductVariantChannelListing | OptionalProductVariantTranslatableContent | OptionalProductVariantTranslation | OptionalPromotion | OptionalPromotionCreatedEvent | OptionalPromotionEndedEvent | OptionalPromotionRule | OptionalPromotionRuleCreatedEvent | OptionalPromotionRuleDeletedEvent | OptionalPromotionRuleTranslatableContent | OptionalPromotionRuleTranslation | OptionalPromotionRuleUpdatedEvent | OptionalPromotionStartedEvent | OptionalPromotionTranslatableContent | OptionalPromotionTranslation | OptionalPromotionUpdatedEvent | OptionalSale | OptionalSaleChannelListing | OptionalSaleTranslatableContent | OptionalSaleTranslation | OptionalShippingMethod | OptionalShippingMethodChannelListing | OptionalShippingMethodPostalCodeRule | OptionalShippingMethodTranslatableContent | OptionalShippingMethodTranslation | OptionalShippingMethodType | OptionalShippingZone | OptionalShopTranslation | OptionalStaffNotificationRecipient | OptionalStock | OptionalTaxClass | OptionalTaxConfiguration | OptionalTransaction | OptionalTransactionEvent | OptionalTransactionItem | OptionalUser | OptionalVoucher | OptionalVoucherChannelListing | OptionalVoucherTranslatableContent | OptionalVoucherTranslation | OptionalWarehouse | OptionalWebhook;
+export type OptionalNode = OptionalAddress | OptionalAllocation | OptionalApp | OptionalAppExtension | OptionalAppInstallation | OptionalAppProblem | OptionalAppToken | OptionalAttribute | OptionalAttributeTranslatableContent | OptionalAttributeTranslation | OptionalAttributeValue | OptionalAttributeValueTranslatableContent | OptionalAttributeValueTranslation | OptionalCategory | OptionalCategoryTranslatableContent | OptionalCategoryTranslation | OptionalChannel | OptionalCheckout | OptionalCheckoutLine | OptionalCollection | OptionalCollectionChannelListing | OptionalCollectionTranslatableContent | OptionalCollectionTranslation | OptionalCustomerEvent | OptionalDigitalContent | OptionalDigitalContentUrl | OptionalEventDelivery | OptionalEventDeliveryAttempt | OptionalExportEvent | OptionalExportFile | OptionalFulfillment | OptionalFulfillmentLine | OptionalGiftCard | OptionalGiftCardEvent | OptionalGiftCardTag | OptionalGroup | OptionalInvoice | OptionalMenu | OptionalMenuItem | OptionalMenuItemTranslatableContent | OptionalMenuItemTranslation | OptionalOrder | OptionalOrderDiscount | OptionalOrderEvent | OptionalOrderLine | OptionalPage | OptionalPageTranslatableContent | OptionalPageTranslation | OptionalPageType | OptionalPayment | OptionalProduct | OptionalProductChannelListing | OptionalProductMedia | OptionalProductTranslatableContent | OptionalProductTranslation | OptionalProductType | OptionalProductVariant | OptionalProductVariantChannelListing | OptionalProductVariantTranslatableContent | OptionalProductVariantTranslation | OptionalPromotion | OptionalPromotionCreatedEvent | OptionalPromotionEndedEvent | OptionalPromotionRule | OptionalPromotionRuleCreatedEvent | OptionalPromotionRuleDeletedEvent | OptionalPromotionRuleTranslatableContent | OptionalPromotionRuleTranslation | OptionalPromotionRuleUpdatedEvent | OptionalPromotionStartedEvent | OptionalPromotionTranslatableContent | OptionalPromotionTranslation | OptionalPromotionUpdatedEvent | OptionalSale | OptionalSaleChannelListing | OptionalSaleTranslatableContent | OptionalSaleTranslation | OptionalShippingMethod | OptionalShippingMethodChannelListing | OptionalShippingMethodPostalCodeRule | OptionalShippingMethodTranslatableContent | OptionalShippingMethodTranslation | OptionalShippingMethodType | OptionalShippingZone | OptionalShopTranslation | OptionalStaffNotificationRecipient | OptionalStock | OptionalTaxClass | OptionalTaxConfiguration | OptionalTransaction | OptionalTransactionEvent | OptionalTransactionItem | OptionalUser | OptionalVoucher | OptionalVoucherChannelListing | OptionalVoucherTranslatableContent | OptionalVoucherTranslation | OptionalWarehouse | OptionalWebhook;
/**
* An object with attributes.
@@ -17444,7 +17972,7 @@ export type OptionalOrder = {
totalCancelPending?: OptionalMoney | undefined;
/** Amount canceled for the order. */
totalCanceled?: OptionalMoney | undefined;
- /** Amount captured for the order. */
+ /** Amount captured for the order. */
totalCaptured?: OptionalMoney | undefined;
/**
* Total amount of ongoing charge requests for the order's transactions.
@@ -17474,7 +18002,11 @@ export type OptionalOrder = {
* Requires one of the following permissions: MANAGE_ORDERS.
*/
totalRemainingGrant?: OptionalMoney | undefined;
- /** Google Analytics tracking client ID. */
+ /**
+ * Google Analytics tracking client ID.
+ *
+ * DEPRECATED: this field will be removed.
+ */
trackingClientId?: Order['trackingClientId'] | undefined;
/** List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. */
transactions?: OptionalTransactionItem[] | undefined;
@@ -19058,6 +19590,12 @@ export type OptionalOrderGrantRefundCreateLineInput = {
quantity?: OrderGrantRefundCreateLineInput['quantity'] | undefined;
/** Reason of the granted refund for the line. */
reason?: OrderGrantRefundCreateLineInput['reason'] | undefined;
+ /**
+ * ID of a `Page` to reference as reason for this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: OrderGrantRefundCreateLineInput['reasonReference'] | undefined;
};
/**
@@ -19168,6 +19706,12 @@ export type OptionalOrderGrantRefundUpdateLineAddInput = {
quantity?: OrderGrantRefundUpdateLineAddInput['quantity'] | undefined;
/** Reason of the granted refund for the line. */
reason?: OrderGrantRefundUpdateLineAddInput['reason'] | undefined;
+ /**
+ * ID of a `Page` to reference as reason for this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: OrderGrantRefundUpdateLineAddInput['reasonReference'] | undefined;
};
/**
@@ -19275,6 +19819,12 @@ export type OptionalOrderGrantedRefundLine = {
quantity?: OrderGrantedRefundLine['quantity'] | undefined;
/** Reason for refunding the line. */
reason?: OrderGrantedRefundLine['reason'] | undefined;
+ /**
+ * Reason Model (Page) reference for this refund line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: Maybe | undefined;
};
/**
@@ -19408,7 +19958,7 @@ export const defineOrderLineFactory: DefineTypeFactoryInterface<
export type OptionalOrderLineCreateInput = {
__typename?: 'OrderLineCreateInput';
- /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
+ /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
forceNewLine?: OrderLineCreateInput['forceNewLine'] | undefined;
/** Custom price of the item.When the line with the same variant will be provided multiple times, the last price will be used. */
price?: OrderLineCreateInput['price'] | undefined;
@@ -19938,6 +20488,18 @@ export type OptionalOrderReturnFulfillmentLineInput = {
fulfillmentLineId?: OrderReturnFulfillmentLineInput['fulfillmentLineId'] | undefined;
/** The number of items to be returned. */
quantity?: OrderReturnFulfillmentLineInput['quantity'] | undefined;
+ /**
+ * Reason for returning the line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason?: OrderReturnFulfillmentLineInput['reason'] | undefined;
+ /**
+ * ID of a `Page` to reference as reason for returning this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: OrderReturnFulfillmentLineInput['reasonReference'] | undefined;
/** Determines, if the line should be added to replace order. */
replace?: OrderReturnFulfillmentLineInput['replace'] | undefined;
};
@@ -19959,6 +20521,18 @@ export type OptionalOrderReturnLineInput = {
orderLineId?: OrderReturnLineInput['orderLineId'] | undefined;
/** The number of items to be returned. */
quantity?: OrderReturnLineInput['quantity'] | undefined;
+ /**
+ * Reason for returning the line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason?: OrderReturnLineInput['reason'] | undefined;
+ /**
+ * ID of a `Page` to reference as reason for returning this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: OrderReturnLineInput['reasonReference'] | undefined;
/** Determines, if the line should be added to replace order. */
replace?: OrderReturnLineInput['replace'] | undefined;
};
@@ -19984,6 +20558,18 @@ export type OptionalOrderReturnProductsInput = {
includeShippingCosts?: OrderReturnProductsInput['includeShippingCosts'] | undefined;
/** List of unfulfilled lines to return. */
orderLines?: Maybe | undefined;
+ /**
+ * Global reason for the return.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason?: OrderReturnProductsInput['reason'] | undefined;
+ /**
+ * ID of a `Page` to reference as reason for the return. Required for staff users when refund reason reference type is configured. Always optional for apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference?: OrderReturnProductsInput['reasonReference'] | undefined;
/** If true, Saleor will call refund action for all lines. */
refund?: OrderReturnProductsInput['refund'] | undefined;
};
@@ -20750,7 +21336,11 @@ export type OptionalPageCreateInput = {
isPublished?: PageCreateInput['isPublished'] | undefined;
/** ID of the page type that page belongs to. */
pageType?: PageCreateInput['pageType'] | undefined;
- /** Publication date. ISO 8601 standard. */
+ /**
+ * Publication date. ISO 8601 standard.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ */
publicationDate?: PageCreateInput['publicationDate'] | undefined;
/** Publication date time. ISO 8601 standard. */
publishedAt?: PageCreateInput['publishedAt'] | undefined;
@@ -20929,7 +21519,11 @@ export type OptionalPageInput = {
content?: PageInput['content'] | undefined;
/** Determines if page is visible in the storefront. */
isPublished?: PageInput['isPublished'] | undefined;
- /** Publication date. ISO 8601 standard. */
+ /**
+ * Publication date. ISO 8601 standard.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ */
publicationDate?: PageInput['publicationDate'] | undefined;
/** Publication date time. ISO 8601 standard. */
publishedAt?: PageInput['publishedAt'] | undefined;
@@ -22115,7 +22709,7 @@ export const definePaymentGatewayInitializeTokenizationErrorFactory: DefineTypeF
{}
> = defineTypeFactory;
-/** Event sent to initialize a new session in payment gateway to store the payment method. */
+/** Event sent to initialize a new session in payment gateway to store the payment method. */
export type OptionalPaymentGatewayInitializeTokenizationSession = {
__typename?: 'PaymentGatewayInitializeTokenizationSession';
/** Channel related to the requested action. */
@@ -23700,7 +24294,11 @@ export type OptionalProductBulkCreateInput = {
category?: ProductBulkCreateInput['category'] | undefined;
/** List of channels in which the product is available. */
channelListings?: Maybe | undefined;
- /** Determine if taxes are being charged for the product. */
+ /**
+ * Determine if taxes are being charged for the product.
+ *
+ * DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ */
chargeTaxes?: ProductBulkCreateInput['chargeTaxes'] | undefined;
/** List of IDs of collections that the product belongs to. */
collections?: ProductBulkCreateInput['collections'] | undefined;
@@ -23738,7 +24336,11 @@ export type OptionalProductBulkCreateInput = {
slug?: ProductBulkCreateInput['slug'] | undefined;
/** 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?: ProductBulkCreateInput['taxClass'] | undefined;
- /** Tax rate for enabled tax gateway. */
+ /**
+ * Tax rate for enabled tax gateway.
+ *
+ * DEPRECATED: this field will be removed. 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?: ProductBulkCreateInput['taxCode'] | undefined;
/** Input list of product variants to create. */
variants?: Maybe | undefined;
@@ -23946,7 +24548,11 @@ export type OptionalProductChannelListingAddInput = {
addVariants?: ProductChannelListingAddInput['addVariants'] | undefined;
/** 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?: ProductChannelListingAddInput['availableForPurchaseAt'] | undefined;
- /** 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. */
+ /**
+ * 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. Use `availableForPurchaseAt` field instead.
+ */
availableForPurchaseDate?: ProductChannelListingAddInput['availableForPurchaseDate'] | undefined;
/** ID of a channel. */
channelId?: ProductChannelListingAddInput['channelId'] | undefined;
@@ -23954,7 +24560,11 @@ export type OptionalProductChannelListingAddInput = {
isAvailableForPurchase?: ProductChannelListingAddInput['isAvailableForPurchase'] | undefined;
/** Determines if object is visible to customers. */
isPublished?: ProductChannelListingAddInput['isPublished'] | undefined;
- /** Publication date. ISO 8601 standard. */
+ /**
+ * Publication date. ISO 8601 standard.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ */
publicationDate?: ProductChannelListingAddInput['publicationDate'] | undefined;
/** Publication date time. ISO 8601 standard. */
publishedAt?: ProductChannelListingAddInput['publishedAt'] | undefined;
@@ -24142,7 +24752,11 @@ export type OptionalProductCreateInput = {
attributes?: Maybe | undefined;
/** ID of the product's category. */
category?: ProductCreateInput['category'] | undefined;
- /** Determine if taxes are being charged for the product. */
+ /**
+ * Determine if taxes are being charged for the product.
+ *
+ * DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ */
chargeTaxes?: ProductCreateInput['chargeTaxes'] | undefined;
/** List of IDs of collections that the product belongs to. */
collections?: ProductCreateInput['collections'] | undefined;
@@ -24178,7 +24792,11 @@ export type OptionalProductCreateInput = {
slug?: ProductCreateInput['slug'] | undefined;
/** 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?: ProductCreateInput['taxClass'] | undefined;
- /** Tax rate for enabled tax gateway. */
+ /**
+ * Tax rate for enabled tax gateway.
+ *
+ * DEPRECATED: this field will be removed. 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?: ProductCreateInput['taxCode'] | undefined;
/** Weight of the Product. */
weight?: ProductCreateInput['weight'] | undefined;
@@ -24331,7 +24949,11 @@ export type OptionalProductFilterInput = {
/** Filter by the date of availability for purchase. */
availableFrom?: ProductFilterInput['availableFrom'] | undefined;
categories?: ProductFilterInput['categories'] | undefined;
- /** Specifies the channel by which the data should be filtered. */
+ /**
+ * Specifies the channel by which the data should be filtered.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: ProductFilterInput['channel'] | undefined;
collections?: ProductFilterInput['collections'] | undefined;
/** Filter on whether product is a gift card or not. */
@@ -24401,7 +25023,11 @@ export type OptionalProductInput = {
attributes?: Maybe | undefined;
/** ID of the product's category. */
category?: ProductInput['category'] | undefined;
- /** Determine if taxes are being charged for the product. */
+ /**
+ * Determine if taxes are being charged for the product.
+ *
+ * DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ */
chargeTaxes?: ProductInput['chargeTaxes'] | undefined;
/** List of IDs of collections that the product belongs to. */
collections?: ProductInput['collections'] | undefined;
@@ -24435,7 +25061,11 @@ export type OptionalProductInput = {
slug?: ProductInput['slug'] | undefined;
/** 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?: ProductInput['taxClass'] | undefined;
- /** Tax rate for enabled tax gateway. */
+ /**
+ * Tax rate for enabled tax gateway.
+ *
+ * DEPRECATED: this field will be removed. 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?: ProductInput['taxCode'] | undefined;
/** Weight of the Product. */
weight?: ProductInput['weight'] | undefined;
@@ -24775,7 +25405,11 @@ export type OptionalProductOrder = {
* Note: this doesn't take translations into account yet.
*/
attributeId?: ProductOrder['attributeId'] | undefined;
- /** Specifies the channel in which to sort the data. */
+ /**
+ * Specifies the channel in which to sort the data.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: ProductOrder['channel'] | undefined;
/** Specifies the direction in which to sort products. */
direction?: ProductOrder['direction'] | undefined;
@@ -25219,7 +25853,11 @@ export type OptionalProductTypeInput = {
slug?: ProductTypeInput['slug'] | undefined;
/** 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?: ProductTypeInput['taxClass'] | undefined;
- /** Tax rate for enabled tax gateway. */
+ /**
+ * Tax rate for enabled tax gateway.
+ *
+ * DEPRECATED: this field will be removed. 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?: ProductTypeInput['taxCode'] | undefined;
/** List of attributes used to distinguish between different variants of a product. */
variantAttributes?: ProductTypeInput['variantAttributes'] | undefined;
@@ -25510,7 +26148,11 @@ export type OptionalProductVariantBulkCreate = {
/** Returns how many objects were created. */
count?: ProductVariantBulkCreate['count'] | undefined;
errors?: OptionalBulkProductError[] | undefined;
- /** List of the created variants. */
+ /**
+ * List of the created variants.
+ *
+ * DEPRECATED: this field will be removed.
+ */
productVariants?: OptionalProductVariant[] | undefined;
/** List of the created variants. */
results?: OptionalProductVariantBulkResult[] | undefined;
@@ -28103,7 +28745,11 @@ export type OptionalPublishableChannelListingInput = {
channelId?: PublishableChannelListingInput['channelId'] | undefined;
/** Determines if object is visible to customers. */
isPublished?: PublishableChannelListingInput['isPublished'] | undefined;
- /** Publication date. ISO 8601 standard. */
+ /**
+ * Publication date. ISO 8601 standard.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
+ */
publicationDate?: PublishableChannelListingInput['publicationDate'] | undefined;
/** Publication date time. ISO 8601 standard. */
publishedAt?: PublishableChannelListingInput['publishedAt'] | undefined;
@@ -28380,6 +29026,8 @@ export type OptionalQuery = {
* Requires one of the following permissions: MANAGE_PRODUCTS.
*/
reportProductSales?: Maybe | undefined;
+ /** Returns related settings. Returns `ReturnSettings` configuration, global for the entire shop. */
+ returnSettings?: OptionalReturnSettings | undefined;
/**
* Look up a sale by ID.
*
@@ -28454,17 +29102,29 @@ export type OptionalQuery = {
* Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
*/
taxCountryConfiguration?: Maybe | undefined;
- /** \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */
+ /**
+ *
+ *
+ * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ */
taxCountryConfigurations?: Maybe | undefined;
/** List of all tax rates available from tax gateway. */
taxTypes?: Maybe | undefined;
/**
* Look up a transaction by ID.
*
- * Requires one of the following permissions: HANDLE_PAYMENTS.
+ * Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
*/
transaction?: Maybe | undefined;
/**
+ * List of transactions. For apps with `MANAGE_ORDERS` permission, returns all transactions. For apps with just `HANDLE_PAYMENTS` permission, returns only transactions created by that app. For staff users, returns transactions from orders and checkouts in channels they have access to.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
+ */
+ transactions?: Maybe | undefined;
+ /**
* Lookup a translatable item by ID.
*
* Requires one of the following permissions: MANAGE_TRANSLATIONS.
@@ -28787,6 +29447,143 @@ export const defineRequestPasswordResetFactory: DefineTypeFactoryInterface<
{}
> = defineTypeFactory;
+/**
+ * Updates ReturnSettings. The `Page` (Model) Type will be cleared from `reasonReferenceType`. When it's cleared, passing reason reference to return mutations is no longer accepted and will raise error.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_SETTINGS.
+ */
+export type OptionalReturnReasonReferenceTypeClear = {
+ __typename?: 'ReturnReasonReferenceTypeClear';
+ errors?: OptionalReturnReasonReferenceTypeClearError[] | undefined;
+ /** Return settings. */
+ returnSettings?: OptionalReturnSettings | undefined;
+ returnSettingsErrors?: OptionalReturnReasonReferenceTypeClearError[] | undefined;
+};
+
+/**
+ * Define factory for {@link ReturnReasonReferenceTypeClear} model.
+ *
+ * @param options
+ * @returns factory {@link ReturnReasonReferenceTypeClearFactoryInterface}
+ */
+export const defineReturnReasonReferenceTypeClearFactory: DefineTypeFactoryInterface<
+ OptionalReturnReasonReferenceTypeClear,
+ {}
+> = defineTypeFactory;
+
+export type OptionalReturnReasonReferenceTypeClearError = {
+ __typename?: 'ReturnReasonReferenceTypeClearError';
+ /** Failed to clear return reason reference type */
+ code?: ReturnReasonReferenceTypeClearError['code'] | undefined;
+ /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */
+ field?: ReturnReasonReferenceTypeClearError['field'] | undefined;
+ /** The error message. */
+ message?: ReturnReasonReferenceTypeClearError['message'] | undefined;
+};
+
+/**
+ * Define factory for {@link ReturnReasonReferenceTypeClearError} model.
+ *
+ * @param options
+ * @returns factory {@link ReturnReasonReferenceTypeClearErrorFactoryInterface}
+ */
+export const defineReturnReasonReferenceTypeClearErrorFactory: DefineTypeFactoryInterface<
+ OptionalReturnReasonReferenceTypeClearError,
+ {}
+> = defineTypeFactory;
+
+/**
+ * Return related settings from site settings.
+ *
+ * Added in Saleor 3.22.
+ */
+export type OptionalReturnSettings = {
+ __typename?: 'ReturnSettings';
+ /** Model type used for return reasons. */
+ reasonReferenceType?: Maybe | undefined;
+};
+
+/**
+ * Define factory for {@link ReturnSettings} model.
+ *
+ * @param options
+ * @returns factory {@link ReturnSettingsFactoryInterface}
+ */
+export const defineReturnSettingsFactory: DefineTypeFactoryInterface<
+ OptionalReturnSettings,
+ {}
+> = defineTypeFactory;
+
+/**
+ * Update return settings across all channels.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_SETTINGS.
+ */
+export type OptionalReturnSettingsUpdate = {
+ __typename?: 'ReturnSettingsUpdate';
+ errors?: OptionalReturnSettingsUpdateError[] | undefined;
+ /** Return settings. */
+ returnSettings?: OptionalReturnSettings | undefined;
+ returnSettingsErrors?: OptionalReturnSettingsUpdateError[] | undefined;
+};
+
+/**
+ * Define factory for {@link ReturnSettingsUpdate} model.
+ *
+ * @param options
+ * @returns factory {@link ReturnSettingsUpdateFactoryInterface}
+ */
+export const defineReturnSettingsUpdateFactory: DefineTypeFactoryInterface<
+ OptionalReturnSettingsUpdate,
+ {}
+> = defineTypeFactory;
+
+export type OptionalReturnSettingsUpdateError = {
+ __typename?: 'ReturnSettingsUpdateError';
+ /** Failed to update Return Settings */
+ code?: ReturnSettingsUpdateError['code'] | undefined;
+ /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */
+ field?: ReturnSettingsUpdateError['field'] | undefined;
+ /** The error message. */
+ message?: ReturnSettingsUpdateError['message'] | undefined;
+};
+
+/**
+ * Define factory for {@link ReturnSettingsUpdateError} model.
+ *
+ * @param options
+ * @returns factory {@link ReturnSettingsUpdateErrorFactoryInterface}
+ */
+export const defineReturnSettingsUpdateErrorFactory: DefineTypeFactoryInterface<
+ OptionalReturnSettingsUpdateError,
+ {}
+> = defineTypeFactory;
+
+export type OptionalReturnSettingsUpdateInput = {
+ __typename?: 'ReturnSettingsUpdateInput';
+ /**
+ * The ID of a model type, that will be used to reference return reasons. All models with of this type will be accepted as return reasons.
+ *
+ * Added in Saleor 3.22.
+ */
+ returnReasonReferenceType?: ReturnSettingsUpdateInput['returnReasonReferenceType'] | undefined;
+};
+
+/**
+ * Define factory for {@link ReturnSettingsUpdateInput} model.
+ *
+ * @param options
+ * @returns factory {@link ReturnSettingsUpdateInputFactoryInterface}
+ */
+export const defineReturnSettingsUpdateInputFactory: DefineTypeFactoryInterface<
+ OptionalReturnSettingsUpdateInput,
+ {}
+> = defineTypeFactory;
+
/**
* Sales allow creating discounts for categories, collections or products and are visible to all the customers.
*
@@ -29250,7 +30047,11 @@ export const defineSaleRemoveCataloguesFactory: DefineTypeFactoryInterface<
export type OptionalSaleSortingInput = {
__typename?: 'SaleSortingInput';
- /** Specifies the channel in which to sort the data. */
+ /**
+ * Specifies the channel in which to sort the data.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: SaleSortingInput['channel'] | undefined;
/** Specifies the direction in which to sort sales. */
direction?: SaleSortingInput['direction'] | undefined;
@@ -30981,7 +31782,11 @@ export type OptionalShopSettingsInput = {
allowLoginWithoutConfirmation?: ShopSettingsInput['allowLoginWithoutConfirmation'] | undefined;
/** Enable automatic fulfillment for all digital products. */
automaticFulfillmentDigitalProducts?: ShopSettingsInput['automaticFulfillmentDigitalProducts'] | undefined;
- /** Charge taxes on shipping. */
+ /**
+ * Charge taxes on shipping.
+ *
+ * DEPRECATED: this field will be removed. To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations.
+ */
chargeTaxesOnShipping?: ShopSettingsInput['chargeTaxesOnShipping'] | undefined;
/** URL of a view where customers can set their password. */
customerSetPasswordUrl?: ShopSettingsInput['customerSetPasswordUrl'] | undefined;
@@ -30997,7 +31802,11 @@ export type OptionalShopSettingsInput = {
defaultWeightUnit?: ShopSettingsInput['defaultWeightUnit'] | undefined;
/** SEO description. */
description?: ShopSettingsInput['description'] | undefined;
- /** Display prices with tax in store. */
+ /**
+ * Display prices with tax in store.
+ *
+ * DEPRECATED: this field will be removed. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.
+ */
displayGrossPrices?: ShopSettingsInput['displayGrossPrices'] | undefined;
/** Enable automatic account confirmation by email. */
enableAccountConfirmationByEmail?: ShopSettingsInput['enableAccountConfirmationByEmail'] | undefined;
@@ -31007,7 +31816,11 @@ export type OptionalShopSettingsInput = {
fulfillmentAutoApprove?: ShopSettingsInput['fulfillmentAutoApprove'] | undefined;
/** Header text. */
headerText?: ShopSettingsInput['headerText'] | undefined;
- /** Include taxes in prices. */
+ /**
+ * Include taxes in prices.
+ *
+ * DEPRECATED: this field will be removed. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.
+ */
includeTaxesInPrices?: ShopSettingsInput['includeTaxesInPrices'] | undefined;
/** Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50. */
limitQuantityPerCheckout?: ShopSettingsInput['limitQuantityPerCheckout'] | undefined;
@@ -31033,6 +31846,8 @@ export type OptionalShopSettingsInput = {
* Use legacy update webhook emission. When enabled, update webhooks (e.g. `customerUpdated`,`productVariantUpdated`) are sent even when only metadata changes. When disabled, update webhooks are not sent for metadata-only changes; only metadata-specific webhooks (e.g., `customerMetadataUpdated`, `productVariantMetadataUpdated`) are sent.
*
* Added in Saleor 3.22.
+ *
+ * DEPRECATED: this field will be removed.
*/
useLegacyUpdateWebhookEmission?: ShopSettingsInput['useLegacyUpdateWebhookEmission'] | undefined;
};
@@ -33300,6 +34115,45 @@ export const defineTransactionChargeRequestedFactory: DefineTypeFactoryInterface
{}
> = defineTypeFactory;
+export type OptionalTransactionCountableConnection = {
+ __typename?: 'TransactionCountableConnection';
+ edges?: OptionalTransactionCountableEdge[] | undefined;
+ /** Pagination data for this connection. */
+ pageInfo?: OptionalPageInfo | undefined;
+ /** A total count of items in the collection. */
+ totalCount?: TransactionCountableConnection['totalCount'] | undefined;
+};
+
+/**
+ * Define factory for {@link TransactionCountableConnection} model.
+ *
+ * @param options
+ * @returns factory {@link TransactionCountableConnectionFactoryInterface}
+ */
+export const defineTransactionCountableConnectionFactory: DefineTypeFactoryInterface<
+ OptionalTransactionCountableConnection,
+ {}
+> = defineTypeFactory;
+
+export type OptionalTransactionCountableEdge = {
+ __typename?: 'TransactionCountableEdge';
+ /** A cursor for use in pagination. */
+ cursor?: TransactionCountableEdge['cursor'] | undefined;
+ /** The item at the end of the edge. */
+ node?: OptionalTransactionItem | undefined;
+};
+
+/**
+ * Define factory for {@link TransactionCountableEdge} model.
+ *
+ * @param options
+ * @returns factory {@link TransactionCountableEdgeFactoryInterface}
+ */
+export const defineTransactionCountableEdgeFactory: DefineTypeFactoryInterface<
+ OptionalTransactionCountableEdge,
+ {}
+> = defineTypeFactory;
+
/**
* Creates transaction for checkout or order.
*
@@ -33513,6 +34367,12 @@ export type OptionalTransactionFilterInput = {
metadata?: Maybe | undefined;
/** Filter by payment method details used to pay for the order. */
paymentMethodDetails?: Maybe | undefined;
+ /**
+ * Filter by PSP reference of transactions.
+ *
+ * Added in Saleor 3.22.
+ */
+ pspReference?: Maybe | undefined;
};
/**
@@ -33730,7 +34590,7 @@ export const defineTransactionItemMetadataUpdatedFactory: DefineTypeFactoryInter
{}
> = defineTypeFactory;
-/** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */
+/** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */
export type OptionalTransactionProcess = {
__typename?: 'TransactionProcess';
/** The json data required to finalize the payment. */
@@ -34044,6 +34904,30 @@ export const defineTransactionUpdateInputFactory: DefineTypeFactoryInterface<
{}
> = defineTypeFactory;
+export type OptionalTransactionWhereInput = {
+ __typename?: 'TransactionWhereInput';
+ /** List of conditions that must be met. */
+ AND?: Maybe | undefined;
+ /** A list of conditions of which at least one must be met. */
+ OR?: Maybe | undefined;
+ /** Filter by app identifier. */
+ appIdentifier?: Maybe | undefined;
+ ids?: TransactionWhereInput['ids'] | undefined;
+ /** Filter by PSP reference. */
+ pspReference?: Maybe | undefined;
+};
+
+/**
+ * Define factory for {@link TransactionWhereInput} model.
+ *
+ * @param options
+ * @returns factory {@link TransactionWhereInputFactoryInterface}
+ */
+export const defineTransactionWhereInputFactory: DefineTypeFactoryInterface<
+ OptionalTransactionWhereInput,
+ {}
+> = defineTypeFactory;
+
export type OptionalTranslatableItem = OptionalAttributeTranslatableContent | OptionalAttributeValueTranslatableContent | OptionalCategoryTranslatableContent | OptionalCollectionTranslatableContent | OptionalMenuItemTranslatableContent | OptionalPageTranslatableContent | OptionalProductTranslatableContent | OptionalProductVariantTranslatableContent | OptionalPromotionRuleTranslatableContent | OptionalPromotionTranslatableContent | OptionalSaleTranslatableContent | OptionalShippingMethodTranslatableContent | OptionalVoucherTranslatableContent;
export type OptionalTranslatableItemConnection = {
@@ -34536,7 +35420,13 @@ export type OptionalUserCreateInput = {
firstName?: UserCreateInput['firstName'] | undefined;
/** User account is active. */
isActive?: UserCreateInput['isActive'] | undefined;
- /** User account is confirmed. */
+ /**
+ * User account is confirmed.
+ *
+ * DEPRECATED: this field will be removed.
+ *
+ * The user will be always set as unconfirmed. The confirmation will take place when the user sets the password.
+ */
isConfirmed?: UserCreateInput['isConfirmed'] | undefined;
/** User language code. */
languageCode?: UserCreateInput['languageCode'] | undefined;
@@ -34763,7 +35653,11 @@ export type OptionalVoucher = {
* Requires one of the following permissions: MANAGE_DISCOUNTS.
*/
channelListings?: Maybe | undefined;
- /** The code of the voucher. */
+ /**
+ * The code of the voucher.
+ *
+ * DEPRECATED: this field will be removed.
+ */
code?: Voucher['code'] | undefined;
/**
* List of codes available for this voucher.
@@ -35401,7 +36295,11 @@ export type OptionalVoucherInput = {
applyOncePerOrder?: VoucherInput['applyOncePerOrder'] | undefined;
/** Categories discounted by the voucher. */
categories?: VoucherInput['categories'] | undefined;
- /** Code to use the voucher. */
+ /**
+ * Code to use the voucher.
+ *
+ * DEPRECATED: this field will be removed. Use `addCodes` instead.
+ */
code?: VoucherInput['code'] | undefined;
/** Collections discounted by the voucher. */
collections?: VoucherInput['collections'] | undefined;
@@ -35505,7 +36403,11 @@ export const defineVoucherRemoveCataloguesFactory: DefineTypeFactoryInterface<
export type OptionalVoucherSortingInput = {
__typename?: 'VoucherSortingInput';
- /** Specifies the channel in which to sort the data. */
+ /**
+ * Specifies the channel in which to sort the data.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
+ */
channel?: VoucherSortingInput['channel'] | undefined;
/** Specifies the direction in which to sort vouchers. */
direction?: VoucherSortingInput['direction'] | undefined;
@@ -35790,7 +36692,11 @@ export type OptionalWarehouseCreateInput = {
externalReference?: WarehouseCreateInput['externalReference'] | undefined;
/** Warehouse name. */
name?: WarehouseCreateInput['name'] | undefined;
- /** Shipping zones supported by the warehouse. */
+ /**
+ * Shipping zones supported by the warehouse.
+ *
+ * DEPRECATED: this field will be removed. Providing the zone ids will raise a ValidationError.
+ */
shippingZones?: WarehouseCreateInput['shippingZones'] | undefined;
/** Warehouse slug. */
slug?: WarehouseCreateInput['slug'] | undefined;
@@ -36167,7 +37073,11 @@ export type OptionalWebhookCreateInput = {
asyncEvents?: WebhookCreateInput['asyncEvents'] | undefined;
/** 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-*`, `Authorization*`, and `BrokerProperties` keys are allowed. */
customHeaders?: WebhookCreateInput['customHeaders'] | undefined;
- /** The events that webhook wants to subscribe. */
+ /**
+ * The events that webhook wants to subscribe.
+ *
+ * DEPRECATED: this field will be removed. Use `asyncEvents` or `syncEvents` instead.
+ */
events?: WebhookCreateInput['events'] | undefined;
/** Determine if webhook will be set active or not. */
isActive?: WebhookCreateInput['isActive'] | undefined;
@@ -36175,7 +37085,11 @@ export type OptionalWebhookCreateInput = {
name?: WebhookCreateInput['name'] | undefined;
/** Subscription query used to define a webhook payload. */
query?: WebhookCreateInput['query'] | undefined;
- /** The secret key used to create a hash signature with each payload. */
+ /**
+ * The secret key used to create a hash signature with each payload.
+ *
+ * DEPRECATED: this field will be removed. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.
+ */
secretKey?: WebhookCreateInput['secretKey'] | undefined;
/** The synchronous events that webhook wants to subscribe. */
syncEvents?: WebhookCreateInput['syncEvents'] | undefined;
@@ -36416,7 +37330,11 @@ export type OptionalWebhookUpdateInput = {
asyncEvents?: WebhookUpdateInput['asyncEvents'] | undefined;
/** 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-*`, `Authorization*`, and `BrokerProperties` keys are allowed. */
customHeaders?: WebhookUpdateInput['customHeaders'] | undefined;
- /** The events that webhook wants to subscribe. */
+ /**
+ * The events that webhook wants to subscribe.
+ *
+ * DEPRECATED: this field will be removed. Use `asyncEvents` or `syncEvents` instead.
+ */
events?: WebhookUpdateInput['events'] | undefined;
/** Determine if webhook will be set active or not. */
isActive?: WebhookUpdateInput['isActive'] | undefined;
@@ -36424,7 +37342,11 @@ export type OptionalWebhookUpdateInput = {
name?: WebhookUpdateInput['name'] | undefined;
/** Subscription query used to define a webhook payload. */
query?: WebhookUpdateInput['query'] | undefined;
- /** Use to create a hash signature with each payload. */
+ /**
+ * Use to create a hash signature with each payload.
+ *
+ * DEPRECATED: this field will be removed. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.
+ */
secretKey?: WebhookUpdateInput['secretKey'] | undefined;
/** The synchronous events that webhook wants to subscribe. */
syncEvents?: WebhookUpdateInput['syncEvents'] | undefined;
diff --git a/src/graphql/fabbricaTypes.generated.ts b/src/graphql/fabbricaTypes.generated.ts
index d74d3aa301a..0588b9258e0 100644
--- a/src/graphql/fabbricaTypes.generated.ts
+++ b/src/graphql/fabbricaTypes.generated.ts
@@ -812,6 +812,7 @@ export type Allocation = Node & {
* within the channel
*
* PRIORITIZE_HIGH_STOCK - allocate stock in a warehouse with the most stock
+ *
*/
export type AllocationStrategyEnum =
| 'PRIORITIZE_HIGH_STOCK'
@@ -896,6 +897,14 @@ export type App = Node & ObjectWithMetadata & {
privateMetafield: Maybe;
/** Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. */
privateMetafields: Maybe;
+ /**
+ * List of problems associated with this app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP, MANAGE_APPS.
+ */
+ problems: Maybe>;
/** Support page for the app. */
supportUrl: Maybe;
/**
@@ -940,6 +949,12 @@ export type AppPrivateMetafieldsArgs = {
keys: InputMaybe>;
};
+
+/** Represents app data. */
+export type AppProblemsArgs = {
+ limit: InputMaybe;
+};
+
/**
* Activate the app.
*
@@ -973,7 +988,7 @@ export type AppBrandLogo = {
/** Represents the app's brand logo data. */
export type AppBrandLogoDefaultArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
@@ -1171,7 +1186,8 @@ export type AppExtensionCountableEdge = {
export type AppExtensionFilterInput = {
/**
* DEPRECATED: Use `mountName` instead.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
mount: InputMaybe>;
/**
@@ -1182,7 +1198,8 @@ export type AppExtensionFilterInput = {
mountName: InputMaybe>;
/**
* DEPRECATED: Use `targetName` instead.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
target: InputMaybe;
/**
@@ -1273,6 +1290,7 @@ export type AppExtensionPossibleOptions = AppExtensionOptionsNewTab | AppExtensi
*
* POPUP - app's extension will be mounted as a popup window
* APP_PAGE - redirect to app's page
+ *
*/
export type AppExtensionTargetEnum =
| 'APP_PAGE'
@@ -1386,7 +1404,7 @@ export type AppManifestBrandLogo = {
/** Represents the app's manifest brand data. */
export type AppManifestBrandLogoDefaultArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
@@ -1450,6 +1468,202 @@ export type AppManifestWebhook = {
targetUrl: Scalars['String'];
};
+/**
+ * Represents a problem associated with an app.
+ *
+ * Added in Saleor 3.22.
+ */
+export type AppProblem = Node & {
+ __typename: 'AppProblem';
+ /**
+ * Number of occurrences.
+ *
+ * Added in Saleor 3.22.
+ */
+ count: Scalars['Int'];
+ /**
+ * The date and time when the problem was created.
+ *
+ * Added in Saleor 3.22.
+ */
+ createdAt: Scalars['DateTime'];
+ /**
+ * Dismissal information. Null if the problem has not been dismissed.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP, MANAGE_APPS.
+ */
+ dismissed: Maybe;
+ /**
+ * The ID of the app problem.
+ *
+ * Added in Saleor 3.22.
+ */
+ id: Scalars['ID'];
+ /**
+ * Whether the problem has reached critical threshold.
+ *
+ * Added in Saleor 3.22.
+ */
+ isCritical: Scalars['Boolean'];
+ /**
+ * Key identifying the type of problem.
+ *
+ * Added in Saleor 3.22.
+ */
+ key: Scalars['String'];
+ /**
+ * The problem message.
+ *
+ * Added in Saleor 3.22.
+ */
+ message: Scalars['String'];
+ /**
+ * The date and time when the problem was last updated.
+ *
+ * Added in Saleor 3.22.
+ */
+ updatedAt: Scalars['DateTime'];
+};
+
+/**
+ * Add a problem to the calling app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP.
+ */
+export type AppProblemCreate = {
+ __typename: 'AppProblemCreate';
+ /** The created or updated app problem. */
+ appProblem: Maybe;
+ errors: Array;
+};
+
+export type AppProblemCreateError = {
+ __typename: 'AppProblemCreateError';
+ /** The error code. */
+ code: AppProblemCreateErrorCode;
+ /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */
+ field: Maybe;
+ /** The error message. */
+ message: Maybe;
+};
+
+export type AppProblemCreateErrorCode =
+ | 'GRAPHQL_ERROR'
+ | 'INVALID'
+ | 'NOT_FOUND'
+ | 'REQUIRED';
+
+export type AppProblemCreateInput = {
+ /** Time window in minutes for aggregating problems with the same key. Defaults to 60. If 0, a new problem is always created. */
+ aggregationPeriod: InputMaybe;
+ /** If set, the problem becomes critical when count reaches this value. If sent again with higher value than already counted, problem can be de-escalated. */
+ criticalThreshold: InputMaybe;
+ /** Key identifying the type of problem. App can add multiple problems under the same key, to merge them together or delete them in batch. Must be between 3 and 128 characters. */
+ key: Scalars['String'];
+ /** The problem message to display. Must be at least 3 characters. Messages longer than 2048 characters will be truncated to 2048 characters with '...' suffix. */
+ message: Scalars['String'];
+};
+
+/**
+ * Dismiss problems for an app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
+ */
+export type AppProblemDismiss = {
+ __typename: 'AppProblemDismiss';
+ errors: Array;
+};
+
+/** Input for app callers to dismiss their own problems. */
+export type AppProblemDismissByAppInput = {
+ /** List of problem IDs to dismiss. Cannot be combined with keys. Max 100. */
+ ids: InputMaybe>;
+ /** List of problem keys to dismiss. Cannot be combined with ids. Max 100. */
+ keys: InputMaybe>;
+};
+
+/** Input for staff callers to dismiss problems by IDs. */
+export type AppProblemDismissByStaffWithIdsInput = {
+ /** List of problem IDs to dismiss. Max 100. */
+ ids: Array;
+};
+
+/** Input for staff callers to dismiss problems by keys. */
+export type AppProblemDismissByStaffWithKeysInput = {
+ /** ID of the app whose problems to dismiss. */
+ app: Scalars['ID'];
+ /** List of problem keys to dismiss. Max 100. */
+ keys: Array;
+};
+
+export type AppProblemDismissError = {
+ __typename: 'AppProblemDismissError';
+ /** The error code. */
+ code: AppProblemDismissErrorCode;
+ /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */
+ field: Maybe;
+ /** The error message. */
+ message: Maybe;
+};
+
+export type AppProblemDismissErrorCode =
+ | 'GRAPHQL_ERROR'
+ | 'INVALID'
+ | 'NOT_FOUND'
+ | 'OUT_OF_SCOPE_APP'
+ | 'REQUIRED';
+
+/** Input for dismissing app problems. Only one can be specified. */
+export type AppProblemDismissInput = {
+ /** For app callers only - dismiss own problems. */
+ byApp: InputMaybe;
+ /** For staff callers - dismiss problems by IDs. */
+ byStaffWithIds: InputMaybe;
+ /** For staff callers - dismiss problems by keys for specified app. */
+ byStaffWithKeys: InputMaybe;
+};
+
+/**
+ * Dismissal information for an app problem.
+ *
+ * Added in Saleor 3.22.
+ */
+export type AppProblemDismissed = {
+ __typename: 'AppProblemDismissed';
+ /**
+ * Whether the problem was dismissed by an App or a User.
+ *
+ * Added in Saleor 3.22.
+ */
+ by: AppProblemDismissedByEnum;
+ /**
+ * The user who dismissed this problem. Null if dismissed by an app or the user was deleted.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_STAFF.
+ */
+ user: Maybe;
+ /**
+ * Email of the user who dismissed this problem. Preserved even if the user is deleted.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_STAFF_USER.
+ */
+ userEmail: Maybe;
+};
+
+export type AppProblemDismissedByEnum =
+ | 'APP'
+ | 'USER';
+
/**
* Re-enable sync webhooks for provided app. Can be used to manually re-enable sync webhooks for the app before the cooldown period ends.
*
@@ -2032,7 +2246,7 @@ export type AssignedSwatchAttributeValue = {
file: Maybe;
/** Hex color code. */
hexColor: Maybe;
- /** Name of the selected swatch value. */
+ /** Name of the selected swatch value. */
name: Maybe;
/** Slug of the selected swatch value. */
slug: Maybe;
@@ -2429,7 +2643,8 @@ export type AttributeCreate = {
export type AttributeCreateInput = {
/**
* Whether the attribute can be displayed in the admin product list.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
availableInGrid: InputMaybe;
/** The entity type which can be used as a reference. */
@@ -2440,7 +2655,8 @@ export type AttributeCreateInput = {
filterableInDashboard: InputMaybe;
/**
* Whether the attribute can be filtered in storefront.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
filterableInStorefront: InputMaybe;
/** The input type to use for entering attribute values in the dashboard. */
@@ -2461,7 +2677,8 @@ export type AttributeCreateInput = {
slug: InputMaybe;
/**
* The position of the attribute in the storefront navigation (0 by default).
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
storefrontSearchPosition: InputMaybe;
/** The attribute type. */
@@ -2558,7 +2775,8 @@ export type AttributeFilterInput = {
availableInGrid: InputMaybe;
/**
* Specifies the channel by which the data should be filtered.
- * @deprecated Use root-level channel argument instead.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
*/
channel: InputMaybe;
filterableInDashboard: InputMaybe;
@@ -2578,31 +2796,36 @@ export type AttributeFilterInput = {
export type AttributeInput = {
/**
* The boolean value of the attribute. Requires `slug` to be provided.
- * @deprecated Use `value` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
*/
boolean: InputMaybe;
/**
* 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. Requires `slug` to be provided.
- * @deprecated Use `value` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
*/
date: InputMaybe;
/**
* The date/time range that the returned values should be in. Requires `slug` to be provided.
- * @deprecated Use `value` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
*/
dateTime: InputMaybe;
/** Internal representation of an attribute name. */
slug: InputMaybe;
- /** Filter by value of the attribute. Only one value input field is allowed. If provided more than one, the error will be raised. Cannot be combined with deprecated fields of `AttributeInput`. */
+ /** Filter by value of the attribute. Only one value input field is allowed. If provided more than one, the error will be raised. Cannot be combined with deprecated fields of `AttributeInput`. */
value: InputMaybe;
/**
* Slugs identifying the attributeValues associated with the Attribute. When specified, it filters the results to include only records with one of the matching values. Requires `slug` to be provided.
- * @deprecated Use `value` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
*/
values: InputMaybe>;
/**
* The range that the returned values should be in. Requires `slug` to be provided.
- * @deprecated Use `value` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `value` instead.
*/
valuesRange: InputMaybe;
};
@@ -2767,7 +2990,8 @@ export type AttributeUpdateInput = {
addValues: InputMaybe>;
/**
* Whether the attribute can be displayed in the admin product list.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
availableInGrid: InputMaybe;
/** External ID of this product. */
@@ -2776,7 +3000,8 @@ export type AttributeUpdateInput = {
filterableInDashboard: InputMaybe;
/**
* Whether the attribute can be filtered in storefront.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
filterableInStorefront: InputMaybe;
/** Whether the attribute is for variants only. */
@@ -2797,7 +3022,8 @@ export type AttributeUpdateInput = {
slug: InputMaybe;
/**
* The position of the attribute in the storefront navigation (0 by default).
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
storefrontSearchPosition: InputMaybe;
/** The unit of attribute values. */
@@ -2974,14 +3200,16 @@ export type AttributeValueCreateInput = {
name: Scalars['String'];
/**
* Represents the text of the attribute value, plain text without formatting.
- * @deprecated The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
+ *
+ * DEPRECATED: this field will be removed.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
*/
plainText: InputMaybe;
/**
* Represents the text of the attribute value, includes formatting.
*
* Rich text format. For reference see https://editorjs.io/
- * @deprecated The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
+ *
+ * DEPRECATED: this field will be removed.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
*/
richText: InputMaybe;
/** Represent value of the attribute value (e.g. color values for swatch attributes). */
@@ -3080,7 +3308,8 @@ export type AttributeValueInput = {
swatch: InputMaybe;
/**
* The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
values: InputMaybe>;
};
@@ -3217,14 +3446,16 @@ export type AttributeValueUpdateInput = {
name: InputMaybe;
/**
* Represents the text of the attribute value, plain text without formatting.
- * @deprecated The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
+ *
+ * DEPRECATED: this field will be removed.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
*/
plainText: InputMaybe;
/**
* Represents the text of the attribute value, includes formatting.
*
* Rich text format. For reference see https://editorjs.io/
- * @deprecated The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
+ *
+ * DEPRECATED: this field will be removed.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute.
*/
richText: InputMaybe;
/** Represent value of the attribute value (e.g. color values for swatch attributes). */
@@ -3316,7 +3547,8 @@ export type BulkAttributeValueInput = {
swatch: InputMaybe;
/**
* The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
values: InputMaybe>;
};
@@ -3518,7 +3750,7 @@ export type CategoryAncestorsArgs = {
/** Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. */
export type CategoryBackgroundImageArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
@@ -3713,7 +3945,8 @@ export type CategorySortField =
export type CategorySortingInput = {
/**
* Specifies the channel in which to sort the data.
- * @deprecated Use root-level channel argument instead.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
*/
channel: InputMaybe;
/** Specifies the direction in which to sort categories. */
@@ -4524,6 +4757,7 @@ export type CheckoutAddressValidationRules = {
* 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
+ *
*/
export type CheckoutAuthorizeStatusEnum =
| 'FULL'
@@ -4569,6 +4803,7 @@ export type CheckoutBillingAddressUpdate = {
* 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
+ *
*/
export type CheckoutChargeStatusEnum =
| 'FULL'
@@ -5092,7 +5327,7 @@ export type CheckoutLineDelete = {
};
export type CheckoutLineInput = {
- /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
+ /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
forceNewLine: InputMaybe;
/**
* Fields required to update the object's metadata. Can be read by any API client authorized to read the object it's attached to.
@@ -5146,7 +5381,8 @@ export type CheckoutLineUpdateInput = {
quantity: InputMaybe;
/**
* ID of the product variant.
- * @deprecated Use `lineId` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `lineId` instead.
*/
variantId: InputMaybe;
};
@@ -5260,7 +5496,11 @@ export type CheckoutSettings = {
* Added in Saleor 3.20.
*/
automaticallyCompleteFullyPaidCheckouts: Scalars['Boolean'];
- /** Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one. */
+ /**
+ * Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
+ *
+ * DEPRECATED: this field will be removed.
+ */
useLegacyErrorFlow: Scalars['Boolean'];
};
@@ -5275,12 +5515,14 @@ export type CheckoutSettingsInput = {
* Default `false`. Determines if the paid checkouts should be automatically completed. This setting applies only to checkouts where payment was processed through transactions.When enabled, the checkout will be automatically completed once the checkout `authorize_status` reaches `FULL`. This occurs when the total sum of charged and authorized transaction amounts equals or exceeds the checkout's total amount.
*
* Added in Saleor 3.20.
- * @deprecated Use `automatic_completion` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `automatic_completion` instead.
*/
automaticallyCompleteFullyPaidCheckouts: InputMaybe;
/**
* Default `true`. Determines if the checkout mutations should use legacy error flow. In legacy flow, all mutations can raise an exception unrelated to the requested action - (e.g. out-of-stock exception when updating checkoutShippingAddress.) If `false`, the errors will be aggregated in `checkout.problems` field. Some of the `problems` can block the finalizing checkout process. The legacy flow will be removed in Saleor 4.0. The flow with `checkout.problems` will be the default one.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
useLegacyErrorFlow: InputMaybe;
};
@@ -5435,7 +5677,7 @@ export type Collection = Node & ObjectWithMetadata & {
/** Represents a collection of products. */
export type CollectionBackgroundImageArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
@@ -5624,7 +5866,8 @@ export type CollectionCreateInput = {
products: InputMaybe>;
/**
* Publication date. ISO 8601 standard.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
publicationDate: InputMaybe;
/** Search engine optimization fields. */
@@ -5712,7 +5955,8 @@ export type CollectionErrorCode =
export type CollectionFilterInput = {
/**
* Specifies the channel by which the data should be filtered.
- * @deprecated Use root-level channel argument instead.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
*/
channel: InputMaybe;
ids: InputMaybe>;
@@ -5751,7 +5995,8 @@ export type CollectionInput = {
privateMetadata: InputMaybe>;
/**
* Publication date. ISO 8601 standard.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
publicationDate: InputMaybe;
/** Search engine optimization fields. */
@@ -5840,7 +6085,8 @@ export type CollectionSortField =
export type CollectionSortingInput = {
/**
* Specifies the channel in which to sort the data.
- * @deprecated Use root-level channel argument instead.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
*/
channel: InputMaybe;
/** Specifies the direction in which to sort collections. */
@@ -7077,7 +7323,8 @@ export type DraftOrderCreateInput = {
customerNote: InputMaybe;
/**
* Discount amount for the order.
- * @deprecated Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
+ *
+ * DEPRECATED: this field will be removed. Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
*/
discount: InputMaybe;
/** External ID of this order. */
@@ -7190,7 +7437,8 @@ export type DraftOrderInput = {
customerNote: InputMaybe;
/**
* Discount amount for the order.
- * @deprecated Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
+ *
+ * DEPRECATED: this field will be removed. Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.
*/
discount: InputMaybe;
/** External ID of this order. */
@@ -7855,6 +8103,18 @@ export type Fulfillment = Node & ObjectWithMetadata & {
privateMetafield: Maybe;
/** Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. */
privateMetafields: Maybe;
+ /**
+ * Reason for the fulfillment action.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason: Maybe;
+ /**
+ * Reason Model (Page) reference for this fulfillment.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: Maybe;
/** Amount of refunded shipping price. */
shippingRefundedAmount: Maybe;
/** Status of fulfillment. */
@@ -8007,6 +8267,18 @@ export type FulfillmentLine = Node & {
orderLine: Maybe;
/** The number of items included in the fulfillment line. */
quantity: Scalars['Int'];
+ /**
+ * Reason for the fulfillment line action.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason: Maybe;
+ /**
+ * Reason Model (Page) reference for this fulfillment line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: Maybe;
};
/** Event sent when fulfillment metadata is updated. */
@@ -8430,12 +8702,14 @@ export type GiftCardCreateInput = {
channel: InputMaybe;
/**
* Code to use the gift card.
- * @deprecated The code is now auto generated.
+ *
+ * DEPRECATED: this field will be removed. The code is now auto generated.
*/
code: InputMaybe;
/**
* End date of the gift card in ISO 8601 format.
- * @deprecated Use `expiryDate` from `expirySettings` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `expiryDate` from `expirySettings` instead.
*/
endDate: InputMaybe;
/** The gift card expiry date. */
@@ -8462,7 +8736,8 @@ export type GiftCardCreateInput = {
privateMetadata: InputMaybe>;
/**
* Start date of the gift card in ISO 8601 format.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
startDate: InputMaybe;
/** Email of the customer to whom gift card will be sent. */
@@ -8837,7 +9112,8 @@ export type GiftCardUpdateInput = {
balanceAmount: InputMaybe;
/**
* End date of the gift card in ISO 8601 format.
- * @deprecated Use `expiryDate` from `expirySettings` instead.
+ *
+ * DEPRECATED: this field will be removed. Use `expiryDate` from `expirySettings` instead.
*/
endDate: InputMaybe;
/** The gift card expiry date. */
@@ -8862,7 +9138,8 @@ export type GiftCardUpdateInput = {
removeTags: InputMaybe>;
/**
* Start date of the gift card in ISO 8601 format.
- * @deprecated Field no longer supported
+ *
+ * DEPRECATED: this field will be removed.
*/
startDate: InputMaybe;
};
@@ -9240,785 +9517,1565 @@ export type JobStatusEnum =
| 'PENDING'
| 'SUCCESS';
+/** Language code enum. It contains all the languages supported by Saleor. */
export type LanguageCodeEnum =
+ /** Afrikaans */
| 'AF'
+ /** Afrikaans (Namibia) */
| 'AF_NA'
+ /** Afrikaans (South Africa) */
| 'AF_ZA'
+ /** Aghem */
| 'AGQ'
+ /** Aghem (Cameroon) */
| 'AGQ_CM'
+ /** Akan */
| 'AK'
+ /** Akan (Ghana) */
| 'AK_GH'
+ /** Amharic */
| 'AM'
+ /** Amharic (Ethiopia) */
| 'AM_ET'
+ /** Arabic */
| 'AR'
+ /** Arabic (United Arab Emirates) */
| 'AR_AE'
+ /** Arabic (Bahrain) */
| 'AR_BH'
+ /** Arabic (Djibouti) */
| 'AR_DJ'
+ /** Arabic (Algeria) */
| 'AR_DZ'
+ /** Arabic (Egypt) */
| 'AR_EG'
+ /** Arabic (Western Sahara) */
| 'AR_EH'
+ /** Arabic (Eritrea) */
| 'AR_ER'
+ /** Arabic (Israel) */
| 'AR_IL'
+ /** Arabic (Iraq) */
| 'AR_IQ'
+ /** Arabic (Jordan) */
| 'AR_JO'
+ /** Arabic (Comoros) */
| 'AR_KM'
+ /** Arabic (Kuwait) */
| 'AR_KW'
+ /** Arabic (Lebanon) */
| 'AR_LB'
+ /** Arabic (Libya) */
| 'AR_LY'
+ /** Arabic (Morocco) */
| 'AR_MA'
+ /** Arabic (Mauritania) */
| 'AR_MR'
+ /** Arabic (Oman) */
| 'AR_OM'
+ /** Arabic (Palestinian Territories) */
| 'AR_PS'
+ /** Arabic (Qatar) */
| 'AR_QA'
+ /** Arabic (Saudi Arabia) */
| 'AR_SA'
+ /** Arabic (Sudan) */
| 'AR_SD'
+ /** Arabic (Somalia) */
| 'AR_SO'
+ /** Arabic (South Sudan) */
| 'AR_SS'
+ /** Arabic (Syria) */
| 'AR_SY'
+ /** Arabic (Chad) */
| 'AR_TD'
+ /** Arabic (Tunisia) */
| 'AR_TN'
+ /** Arabic (Yemen) */
| 'AR_YE'
+ /** Assamese */
| 'AS'
+ /** Asu */
| 'ASA'
+ /** Asu (Tanzania) */
| 'ASA_TZ'
+ /** Asturian */
| 'AST'
+ /** Asturian (Spain) */
| 'AST_ES'
+ /** Assamese (India) */
| 'AS_IN'
+ /** Azerbaijani */
| 'AZ'
+ /** Azerbaijani (Cyrillic) */
| 'AZ_CYRL'
+ /** Azerbaijani (Cyrillic, Azerbaijan) */
| 'AZ_CYRL_AZ'
+ /** Azerbaijani (Latin) */
| 'AZ_LATN'
+ /** Azerbaijani (Latin, Azerbaijan) */
| 'AZ_LATN_AZ'
+ /** Basaa */
| 'BAS'
+ /** Basaa (Cameroon) */
| 'BAS_CM'
+ /** Belarusian */
| 'BE'
+ /** Bemba */
| 'BEM'
+ /** Bemba (Zambia) */
| 'BEM_ZM'
+ /** Bena */
| 'BEZ'
+ /** Bena (Tanzania) */
| 'BEZ_TZ'
+ /** Belarusian (Belarus) */
| 'BE_BY'
+ /** Bulgarian */
| 'BG'
+ /** Bulgarian (Bulgaria) */
| 'BG_BG'
+ /** Bambara */
| 'BM'
+ /** Bambara (Mali) */
| 'BM_ML'
+ /** Bangla */
| 'BN'
+ /** Bangla (Bangladesh) */
| 'BN_BD'
+ /** Bangla (India) */
| 'BN_IN'
+ /** Tibetan */
| 'BO'
+ /** Tibetan (China) */
| 'BO_CN'
+ /** Tibetan (India) */
| 'BO_IN'
+ /** Breton */
| 'BR'
+ /** Bodo */
| 'BRX'
+ /** Bodo (India) */
| 'BRX_IN'
+ /** Breton (France) */
| 'BR_FR'
+ /** Bosnian */
| 'BS'
+ /** Bosnian (Cyrillic) */
| 'BS_CYRL'
+ /** Bosnian (Cyrillic, Bosnia & Herzegovina) */
| 'BS_CYRL_BA'
+ /** Bosnian (Latin) */
| 'BS_LATN'
+ /** Bosnian (Latin, Bosnia & Herzegovina) */
| 'BS_LATN_BA'
+ /** Catalan */
| 'CA'
+ /** Catalan (Andorra) */
| 'CA_AD'
+ /** Catalan (Spain) */
| 'CA_ES'
+ /** Catalan (Spain, Valencian) */
| 'CA_ES_VALENCIA'
+ /** Catalan (France) */
| 'CA_FR'
+ /** Catalan (Italy) */
| 'CA_IT'
+ /** Chakma */
| 'CCP'
+ /** Chakma (Bangladesh) */
| 'CCP_BD'
+ /** Chakma (India) */
| 'CCP_IN'
+ /** Chechen */
| 'CE'
+ /** Cebuano */
| 'CEB'
+ /** Cebuano (Philippines) */
| 'CEB_PH'
+ /** Chechen (Russia) */
| 'CE_RU'
+ /** Chiga */
| 'CGG'
+ /** Chiga (Uganda) */
| 'CGG_UG'
+ /** Cherokee */
| 'CHR'
+ /** Cherokee (United States) */
| 'CHR_US'
+ /** Central Kurdish */
| 'CKB'
+ /** Central Kurdish (Iraq) */
| 'CKB_IQ'
+ /** Central Kurdish (Iran) */
| 'CKB_IR'
+ /** Czech */
| 'CS'
+ /** Czech (Czechia) */
| 'CS_CZ'
+ /** Church Slavic */
| 'CU'
+ /** Church Slavic (Russia) */
| 'CU_RU'
+ /** Welsh */
| 'CY'
+ /** Welsh (United Kingdom) */
| 'CY_GB'
+ /** Danish */
| 'DA'
+ /** Taita */
| 'DAV'
+ /** Taita (Kenya) */
| 'DAV_KE'
+ /** Danish (Denmark) */
| 'DA_DK'
+ /** Danish (Greenland) */
| 'DA_GL'
+ /** German */
| 'DE'
+ /** German (Austria) */
| 'DE_AT'
+ /** German (Belgium) */
| 'DE_BE'
+ /** German (Switzerland) */
| 'DE_CH'
+ /** German (Germany) */
| 'DE_DE'
+ /** German (Italy) */
| 'DE_IT'
+ /** German (Liechtenstein) */
| 'DE_LI'
+ /** German (Luxembourg) */
| 'DE_LU'
+ /** Zarma */
| 'DJE'
+ /** Zarma (Niger) */
| 'DJE_NE'
+ /** Lower Sorbian */
| 'DSB'
+ /** Lower Sorbian (Germany) */
| 'DSB_DE'
+ /** Duala */
| 'DUA'
+ /** Duala (Cameroon) */
| 'DUA_CM'
+ /** Jola-Fonyi */
| 'DYO'
+ /** Jola-Fonyi (Senegal) */
| 'DYO_SN'
+ /** Dzongkha */
| 'DZ'
+ /** Dzongkha (Bhutan) */
| 'DZ_BT'
+ /** Embu */
| 'EBU'
+ /** Embu (Kenya) */
| 'EBU_KE'
+ /** Ewe */
| 'EE'
+ /** Ewe (Ghana) */
| 'EE_GH'
+ /** Ewe (Togo) */
| 'EE_TG'
+ /** Greek */
| 'EL'
+ /** Greek (Cyprus) */
| 'EL_CY'
+ /** Greek (Greece) */
| 'EL_GR'
+ /** English */
| 'EN'
+ /** English (United Arab Emirates) */
| 'EN_AE'
+ /** English (Antigua & Barbuda) */
| 'EN_AG'
+ /** English (Anguilla) */
| 'EN_AI'
+ /** English (American Samoa) */
| 'EN_AS'
+ /** English (Austria) */
| 'EN_AT'
+ /** English (Australia) */
| 'EN_AU'
+ /** English (Barbados) */
| 'EN_BB'
+ /** English (Belgium) */
| 'EN_BE'
+ /** English (Burundi) */
| 'EN_BI'
+ /** English (Bermuda) */
| 'EN_BM'
+ /** English (Bahamas) */
| 'EN_BS'
+ /** English (Botswana) */
| 'EN_BW'
+ /** English (Belize) */
| 'EN_BZ'
+ /** English (Canada) */
| 'EN_CA'
+ /** English (Cocos (Keeling) Islands) */
| 'EN_CC'
+ /** English (Switzerland) */
| 'EN_CH'
+ /** English (Cook Islands) */
| 'EN_CK'
+ /** English (Cameroon) */
| 'EN_CM'
+ /** English (Christmas Island) */
| 'EN_CX'
+ /** English (Cyprus) */
| 'EN_CY'
+ /** English (Germany) */
| 'EN_DE'
+ /** English (Diego Garcia) */
| 'EN_DG'
+ /** English (Denmark) */
| 'EN_DK'
+ /** English (Dominica) */
| 'EN_DM'
+ /** English (Eritrea) */
| 'EN_ER'
+ /** English (Finland) */
| 'EN_FI'
+ /** English (Fiji) */
| 'EN_FJ'
+ /** English (Falkland Islands) */
| 'EN_FK'
+ /** English (Micronesia) */
| 'EN_FM'
+ /** English (United Kingdom) */
| 'EN_GB'
+ /** English (Grenada) */
| 'EN_GD'
+ /** English (Guernsey) */
| 'EN_GG'
+ /** English (Ghana) */
| 'EN_GH'
+ /** English (Gibraltar) */
| 'EN_GI'
+ /** English (Gambia) */
| 'EN_GM'
+ /** English (Guam) */
| 'EN_GU'
+ /** English (Guyana) */
| 'EN_GY'
+ /** English (Hong Kong SAR China) */
| 'EN_HK'
+ /** English (Ireland) */
| 'EN_IE'
+ /** English (Israel) */
| 'EN_IL'
+ /** English (Isle of Man) */
| 'EN_IM'
+ /** English (India) */
| 'EN_IN'
+ /** English (British Indian Ocean Territory) */
| 'EN_IO'
+ /** English (Jersey) */
| 'EN_JE'
+ /** English (Jamaica) */
| 'EN_JM'
+ /** English (Kenya) */
| 'EN_KE'
+ /** English (Kiribati) */
| 'EN_KI'
+ /** English (St. Kitts & Nevis) */
| 'EN_KN'
+ /** English (Cayman Islands) */
| 'EN_KY'
+ /** English (St. Lucia) */
| 'EN_LC'
+ /** English (Liberia) */
| 'EN_LR'
+ /** English (Lesotho) */
| 'EN_LS'
+ /** English (Madagascar) */
| 'EN_MG'
+ /** English (Marshall Islands) */
| 'EN_MH'
+ /** English (Macao SAR China) */
| 'EN_MO'
+ /** English (Northern Mariana Islands) */
| 'EN_MP'
+ /** English (Montserrat) */
| 'EN_MS'
+ /** English (Malta) */
| 'EN_MT'
+ /** English (Mauritius) */
| 'EN_MU'
+ /** English (Malawi) */
| 'EN_MW'
+ /** English (Malaysia) */
| 'EN_MY'
+ /** English (Namibia) */
| 'EN_NA'
+ /** English (Norfolk Island) */
| 'EN_NF'
+ /** English (Nigeria) */
| 'EN_NG'
+ /** English (Netherlands) */
| 'EN_NL'
+ /** English (Nauru) */
| 'EN_NR'
+ /** English (Niue) */
| 'EN_NU'
+ /** English (New Zealand) */
| 'EN_NZ'
+ /** English (Papua New Guinea) */
| 'EN_PG'
+ /** English (Philippines) */
| 'EN_PH'
+ /** English (Pakistan) */
| 'EN_PK'
+ /** English (Pitcairn Islands) */
| 'EN_PN'
+ /** English (Puerto Rico) */
| 'EN_PR'
+ /** English (Palau) */
| 'EN_PW'
+ /** English (Rwanda) */
| 'EN_RW'
+ /** English (Solomon Islands) */
| 'EN_SB'
+ /** English (Seychelles) */
| 'EN_SC'
+ /** English (Sudan) */
| 'EN_SD'
+ /** English (Sweden) */
| 'EN_SE'
+ /** English (Singapore) */
| 'EN_SG'
+ /** English (St. Helena) */
| 'EN_SH'
+ /** English (Slovenia) */
| 'EN_SI'
+ /** English (Sierra Leone) */
| 'EN_SL'
+ /** English (South Sudan) */
| 'EN_SS'
+ /** English (Sint Maarten) */
| 'EN_SX'
+ /** English (Eswatini) */
| 'EN_SZ'
+ /** English (Turks & Caicos Islands) */
| 'EN_TC'
+ /** English (Tokelau) */
| 'EN_TK'
+ /** English (Tonga) */
| 'EN_TO'
+ /** English (Trinidad & Tobago) */
| 'EN_TT'
+ /** English (Tuvalu) */
| 'EN_TV'
+ /** English (Tanzania) */
| 'EN_TZ'
+ /** English (Uganda) */
| 'EN_UG'
+ /** English (U.S. Outlying Islands) */
| 'EN_UM'
+ /** English (United States) */
| 'EN_US'
+ /** English (St. Vincent & Grenadines) */
| 'EN_VC'
+ /** English (British Virgin Islands) */
| 'EN_VG'
+ /** English (U.S. Virgin Islands) */
| 'EN_VI'
+ /** English (Vanuatu) */
| 'EN_VU'
+ /** English (Samoa) */
| 'EN_WS'
+ /** English (South Africa) */
| 'EN_ZA'
+ /** English (Zambia) */
| 'EN_ZM'
+ /** English (Zimbabwe) */
| 'EN_ZW'
+ /** Esperanto */
| 'EO'
+ /** Spanish */
| 'ES'
+ /** Spanish (Argentina) */
| 'ES_AR'
+ /** Spanish (Bolivia) */
| 'ES_BO'
+ /** Spanish (Brazil) */
| 'ES_BR'
+ /** Spanish (Belize) */
| 'ES_BZ'
+ /** Spanish (Chile) */
| 'ES_CL'
+ /** Spanish (Colombia) */
| 'ES_CO'
+ /** Spanish (Costa Rica) */
| 'ES_CR'
+ /** Spanish (Cuba) */
| 'ES_CU'
+ /** Spanish (Dominican Republic) */
| 'ES_DO'
+ /** Spanish (Ceuta & Melilla) */
| 'ES_EA'
+ /** Spanish (Ecuador) */
| 'ES_EC'
+ /** Spanish (Spain) */
| 'ES_ES'
+ /** Spanish (Equatorial Guinea) */
| 'ES_GQ'
+ /** Spanish (Guatemala) */
| 'ES_GT'
+ /** Spanish (Honduras) */
| 'ES_HN'
+ /** Spanish (Canary Islands) */
| 'ES_IC'
+ /** Spanish (Mexico) */
| 'ES_MX'
+ /** Spanish (Nicaragua) */
| 'ES_NI'
+ /** Spanish (Panama) */
| 'ES_PA'
+ /** Spanish (Peru) */
| 'ES_PE'
+ /** Spanish (Philippines) */
| 'ES_PH'
+ /** Spanish (Puerto Rico) */
| 'ES_PR'
+ /** Spanish (Paraguay) */
| 'ES_PY'
+ /** Spanish (El Salvador) */
| 'ES_SV'
+ /** Spanish (United States) */
| 'ES_US'
+ /** Spanish (Uruguay) */
| 'ES_UY'
+ /** Spanish (Venezuela) */
| 'ES_VE'
+ /** Estonian */
| 'ET'
+ /** Estonian (Estonia) */
| 'ET_EE'
+ /** Basque */
| 'EU'
+ /** Basque (Spain) */
| 'EU_ES'
+ /** Ewondo */
| 'EWO'
+ /** Ewondo (Cameroon) */
| 'EWO_CM'
+ /** Persian */
| 'FA'
+ /** Persian (Afghanistan) */
| 'FA_AF'
+ /** Persian (Iran) */
| 'FA_IR'
+ /** Fulah */
| 'FF'
+ /** Fulah (Adlam) */
| 'FF_ADLM'
+ /** Fulah (Adlam, Burkina Faso) */
| 'FF_ADLM_BF'
+ /** Fulah (Adlam, Cameroon) */
| 'FF_ADLM_CM'
+ /** Fulah (Adlam, Ghana) */
| 'FF_ADLM_GH'
+ /** Fulah (Adlam, Gambia) */
| 'FF_ADLM_GM'
+ /** Fulah (Adlam, Guinea) */
| 'FF_ADLM_GN'
+ /** Fulah (Adlam, Guinea-Bissau) */
| 'FF_ADLM_GW'
+ /** Fulah (Adlam, Liberia) */
| 'FF_ADLM_LR'
+ /** Fulah (Adlam, Mauritania) */
| 'FF_ADLM_MR'
+ /** Fulah (Adlam, Niger) */
| 'FF_ADLM_NE'
+ /** Fulah (Adlam, Nigeria) */
| 'FF_ADLM_NG'
+ /** Fulah (Adlam, Sierra Leone) */
| 'FF_ADLM_SL'
+ /** Fulah (Adlam, Senegal) */
| 'FF_ADLM_SN'
+ /** Fulah (Latin) */
| 'FF_LATN'
+ /** Fulah (Latin, Burkina Faso) */
| 'FF_LATN_BF'
+ /** Fulah (Latin, Cameroon) */
| 'FF_LATN_CM'
+ /** Fulah (Latin, Ghana) */
| 'FF_LATN_GH'
+ /** Fulah (Latin, Gambia) */
| 'FF_LATN_GM'
+ /** Fulah (Latin, Guinea) */
| 'FF_LATN_GN'
+ /** Fulah (Latin, Guinea-Bissau) */
| 'FF_LATN_GW'
+ /** Fulah (Latin, Liberia) */
| 'FF_LATN_LR'
+ /** Fulah (Latin, Mauritania) */
| 'FF_LATN_MR'
+ /** Fulah (Latin, Niger) */
| 'FF_LATN_NE'
+ /** Fulah (Latin, Nigeria) */
| 'FF_LATN_NG'
+ /** Fulah (Latin, Sierra Leone) */
| 'FF_LATN_SL'
+ /** Fulah (Latin, Senegal) */
| 'FF_LATN_SN'
+ /** Finnish */
| 'FI'
+ /** Filipino */
| 'FIL'
+ /** Filipino (Philippines) */
| 'FIL_PH'
+ /** Finnish (Finland) */
| 'FI_FI'
+ /** Faroese */
| 'FO'
+ /** Faroese (Denmark) */
| 'FO_DK'
+ /** Faroese (Faroe Islands) */
| 'FO_FO'
+ /** French */
| 'FR'
+ /** French (Belgium) */
| 'FR_BE'
+ /** French (Burkina Faso) */
| 'FR_BF'
+ /** French (Burundi) */
| 'FR_BI'
+ /** French (Benin) */
| 'FR_BJ'
+ /** French (St. Barthélemy) */
| 'FR_BL'
+ /** French (Canada) */
| 'FR_CA'
+ /** French (Congo - Kinshasa) */
| 'FR_CD'
+ /** French (Central African Republic) */
| 'FR_CF'
+ /** French (Congo - Brazzaville) */
| 'FR_CG'
+ /** French (Switzerland) */
| 'FR_CH'
+ /** French (Côte d’Ivoire) */
| 'FR_CI'
+ /** French (Cameroon) */
| 'FR_CM'
+ /** French (Djibouti) */
| 'FR_DJ'
+ /** French (Algeria) */
| 'FR_DZ'
+ /** French (France) */
| 'FR_FR'
+ /** French (Gabon) */
| 'FR_GA'
+ /** French (French Guiana) */
| 'FR_GF'
+ /** French (Guinea) */
| 'FR_GN'
+ /** French (Guadeloupe) */
| 'FR_GP'
+ /** French (Equatorial Guinea) */
| 'FR_GQ'
+ /** French (Haiti) */
| 'FR_HT'
+ /** French (Comoros) */
| 'FR_KM'
+ /** French (Luxembourg) */
| 'FR_LU'
+ /** French (Morocco) */
| 'FR_MA'
+ /** French (Monaco) */
| 'FR_MC'
+ /** French (St. Martin) */
| 'FR_MF'
+ /** French (Madagascar) */
| 'FR_MG'
+ /** French (Mali) */
| 'FR_ML'
+ /** French (Martinique) */
| 'FR_MQ'
+ /** French (Mauritania) */
| 'FR_MR'
+ /** French (Mauritius) */
| 'FR_MU'
+ /** French (New Caledonia) */
| 'FR_NC'
+ /** French (Niger) */
| 'FR_NE'
+ /** French (French Polynesia) */
| 'FR_PF'
+ /** French (St. Pierre & Miquelon) */
| 'FR_PM'
+ /** French (Réunion) */
| 'FR_RE'
+ /** French (Rwanda) */
| 'FR_RW'
+ /** French (Seychelles) */
| 'FR_SC'
+ /** French (Senegal) */
| 'FR_SN'
+ /** French (Syria) */
| 'FR_SY'
+ /** French (Chad) */
| 'FR_TD'
+ /** French (Togo) */
| 'FR_TG'
+ /** French (Tunisia) */
| 'FR_TN'
+ /** French (Vanuatu) */
| 'FR_VU'
+ /** French (Wallis & Futuna) */
| 'FR_WF'
+ /** French (Mayotte) */
| 'FR_YT'
+ /** Friulian */
| 'FUR'
+ /** Friulian (Italy) */
| 'FUR_IT'
+ /** Western Frisian */
| 'FY'
+ /** Western Frisian (Netherlands) */
| 'FY_NL'
+ /** Irish */
| 'GA'
+ /** Irish (United Kingdom) */
| 'GA_GB'
+ /** Irish (Ireland) */
| 'GA_IE'
+ /** Scottish Gaelic */
| 'GD'
+ /** Scottish Gaelic (United Kingdom) */
| 'GD_GB'
+ /** Galician */
| 'GL'
+ /** Galician (Spain) */
| 'GL_ES'
+ /** Swiss German */
| 'GSW'
+ /** Swiss German (Switzerland) */
| 'GSW_CH'
+ /** Swiss German (France) */
| 'GSW_FR'
+ /** Swiss German (Liechtenstein) */
| 'GSW_LI'
+ /** Gujarati */
| 'GU'
+ /** Gusii */
| 'GUZ'
+ /** Gusii (Kenya) */
| 'GUZ_KE'
+ /** Gujarati (India) */
| 'GU_IN'
+ /** Manx */
| 'GV'
+ /** Manx (Isle of Man) */
| 'GV_IM'
+ /** Hausa */
| 'HA'
+ /** Hawaiian */
| 'HAW'
+ /** Hawaiian (United States) */
| 'HAW_US'
+ /** Hausa (Ghana) */
| 'HA_GH'
+ /** Hausa (Niger) */
| 'HA_NE'
+ /** Hausa (Nigeria) */
| 'HA_NG'
+ /** Hebrew */
| 'HE'
+ /** Hebrew (Israel) */
| 'HE_IL'
+ /** Hindi */
| 'HI'
+ /** Hindi (India) */
| 'HI_IN'
+ /** Croatian */
| 'HR'
+ /** Croatian (Bosnia & Herzegovina) */
| 'HR_BA'
+ /** Croatian (Croatia) */
| 'HR_HR'
+ /** Upper Sorbian */
| 'HSB'
+ /** Upper Sorbian (Germany) */
| 'HSB_DE'
+ /** Hungarian */
| 'HU'
+ /** Hungarian (Hungary) */
| 'HU_HU'
+ /** Armenian */
| 'HY'
+ /** Armenian (Armenia) */
| 'HY_AM'
+ /** Interlingua */
| 'IA'
+ /** Indonesian */
| 'ID'
+ /** Indonesian (Indonesia) */
| 'ID_ID'
+ /** Igbo */
| 'IG'
+ /** Igbo (Nigeria) */
| 'IG_NG'
+ /** Sichuan Yi */
| 'II'
+ /** Sichuan Yi (China) */
| 'II_CN'
+ /** Icelandic */
| 'IS'
+ /** Icelandic (Iceland) */
| 'IS_IS'
+ /** Italian */
| 'IT'
+ /** Italian (Switzerland) */
| 'IT_CH'
+ /** Italian (Italy) */
| 'IT_IT'
+ /** Italian (San Marino) */
| 'IT_SM'
+ /** Italian (Vatican City) */
| 'IT_VA'
+ /** Japanese */
| 'JA'
+ /** Japanese (Japan) */
| 'JA_JP'
+ /** Ngomba */
| 'JGO'
+ /** Ngomba (Cameroon) */
| 'JGO_CM'
+ /** Machame */
| 'JMC'
+ /** Machame (Tanzania) */
| 'JMC_TZ'
+ /** Javanese */
| 'JV'
+ /** Javanese (Indonesia) */
| 'JV_ID'
+ /** Georgian */
| 'KA'
+ /** Kabyle */
| 'KAB'
+ /** Kabyle (Algeria) */
| 'KAB_DZ'
+ /** Kamba */
| 'KAM'
+ /** Kamba (Kenya) */
| 'KAM_KE'
+ /** Georgian (Georgia) */
| 'KA_GE'
+ /** Makonde */
| 'KDE'
+ /** Makonde (Tanzania) */
| 'KDE_TZ'
+ /** Kabuverdianu */
| 'KEA'
+ /** Kabuverdianu (Cape Verde) */
| 'KEA_CV'
+ /** Koyra Chiini */
| 'KHQ'
+ /** Koyra Chiini (Mali) */
| 'KHQ_ML'
+ /** Kikuyu */
| 'KI'
+ /** Kikuyu (Kenya) */
| 'KI_KE'
+ /** Kazakh */
| 'KK'
+ /** Kako */
| 'KKJ'
+ /** Kako (Cameroon) */
| 'KKJ_CM'
+ /** Kazakh (Kazakhstan) */
| 'KK_KZ'
+ /** Kalaallisut */
| 'KL'
+ /** Kalenjin */
| 'KLN'
+ /** Kalenjin (Kenya) */
| 'KLN_KE'
+ /** Kalaallisut (Greenland) */
| 'KL_GL'
+ /** Khmer */
| 'KM'
+ /** Khmer (Cambodia) */
| 'KM_KH'
+ /** Kannada */
| 'KN'
+ /** Kannada (India) */
| 'KN_IN'
+ /** Korean */
| 'KO'
+ /** Konkani */
| 'KOK'
+ /** Konkani (India) */
| 'KOK_IN'
+ /** Korean (North Korea) */
| 'KO_KP'
+ /** Korean (South Korea) */
| 'KO_KR'
+ /** Kashmiri */
| 'KS'
+ /** Shambala */
| 'KSB'
+ /** Shambala (Tanzania) */
| 'KSB_TZ'
+ /** Bafia */
| 'KSF'
+ /** Bafia (Cameroon) */
| 'KSF_CM'
+ /** Colognian */
| 'KSH'
+ /** Colognian (Germany) */
| 'KSH_DE'
+ /** Kashmiri (Arabic) */
| 'KS_ARAB'
+ /** Kashmiri (Arabic, India) */
| 'KS_ARAB_IN'
+ /** Kurdish */
| 'KU'
+ /** Kurdish (Turkey) */
| 'KU_TR'
+ /** Cornish */
| 'KW'
+ /** Cornish (United Kingdom) */
| 'KW_GB'
+ /** Kyrgyz */
| 'KY'
+ /** Kyrgyz (Kyrgyzstan) */
| 'KY_KG'
+ /** Langi */
| 'LAG'
+ /** Langi (Tanzania) */
| 'LAG_TZ'
+ /** Luxembourgish */
| 'LB'
+ /** Luxembourgish (Luxembourg) */
| 'LB_LU'
+ /** Ganda */
| 'LG'
+ /** Ganda (Uganda) */
| 'LG_UG'
+ /** Lakota */
| 'LKT'
+ /** Lakota (United States) */
| 'LKT_US'
+ /** Lingala */
| 'LN'
+ /** Lingala (Angola) */
| 'LN_AO'
+ /** Lingala (Congo - Kinshasa) */
| 'LN_CD'
+ /** Lingala (Central African Republic) */
| 'LN_CF'
+ /** Lingala (Congo - Brazzaville) */
| 'LN_CG'
+ /** Lao */
| 'LO'
+ /** Lao (Laos) */
| 'LO_LA'
+ /** Northern Luri */
| 'LRC'
+ /** Northern Luri (Iraq) */
| 'LRC_IQ'
+ /** Northern Luri (Iran) */
| 'LRC_IR'
+ /** Lithuanian */
| 'LT'
+ /** Lithuanian (Lithuania) */
| 'LT_LT'
+ /** Luba-Katanga */
| 'LU'
+ /** Luo */
| 'LUO'
+ /** Luo (Kenya) */
| 'LUO_KE'
+ /** Luyia */
| 'LUY'
+ /** Luyia (Kenya) */
| 'LUY_KE'
+ /** Luba-Katanga (Congo - Kinshasa) */
| 'LU_CD'
+ /** Latvian */
| 'LV'
+ /** Latvian (Latvia) */
| 'LV_LV'
+ /** Maithili */
| 'MAI'
+ /** Maithili (India) */
| 'MAI_IN'
+ /** Masai */
| 'MAS'
+ /** Masai (Kenya) */
| 'MAS_KE'
+ /** Masai (Tanzania) */
| 'MAS_TZ'
+ /** Meru */
| 'MER'
+ /** Meru (Kenya) */
| 'MER_KE'
+ /** Morisyen */
| 'MFE'
+ /** Morisyen (Mauritius) */
| 'MFE_MU'
+ /** Malagasy */
| 'MG'
+ /** Makhuwa-Meetto */
| 'MGH'
+ /** Makhuwa-Meetto (Mozambique) */
| 'MGH_MZ'
+ /** Metaʼ */
| 'MGO'
+ /** Metaʼ (Cameroon) */
| 'MGO_CM'
+ /** Malagasy (Madagascar) */
| 'MG_MG'
+ /** Maori */
| 'MI'
+ /** Maori (New Zealand) */
| 'MI_NZ'
+ /** Macedonian */
| 'MK'
+ /** Macedonian (North Macedonia) */
| 'MK_MK'
+ /** Malayalam */
| 'ML'
+ /** Malayalam (India) */
| 'ML_IN'
+ /** Mongolian */
| 'MN'
+ /** Manipuri */
| 'MNI'
+ /** Manipuri (Bangla) */
| 'MNI_BENG'
+ /** Manipuri (Bangla, India) */
| 'MNI_BENG_IN'
+ /** Mongolian (Mongolia) */
| 'MN_MN'
+ /** Marathi */
| 'MR'
+ /** Marathi (India) */
| 'MR_IN'
+ /** Malay */
| 'MS'
+ /** Malay (Brunei) */
| 'MS_BN'
+ /** Malay (Indonesia) */
| 'MS_ID'
+ /** Malay (Malaysia) */
| 'MS_MY'
+ /** Malay (Singapore) */
| 'MS_SG'
+ /** Maltese */
| 'MT'
+ /** Maltese (Malta) */
| 'MT_MT'
+ /** Mundang */
| 'MUA'
+ /** Mundang (Cameroon) */
| 'MUA_CM'
+ /** Burmese */
| 'MY'
+ /** Burmese (Myanmar (Burma)) */
| 'MY_MM'
+ /** Mazanderani */
| 'MZN'
+ /** Mazanderani (Iran) */
| 'MZN_IR'
+ /** Nama */
| 'NAQ'
+ /** Nama (Namibia) */
| 'NAQ_NA'
+ /** Norwegian Bokmål */
| 'NB'
+ /** Norwegian Bokmål (Norway) */
| 'NB_NO'
+ /** Norwegian Bokmål (Svalbard & Jan Mayen) */
| 'NB_SJ'
+ /** North Ndebele */
| 'ND'
+ /** Low German */
| 'NDS'
+ /** Low German (Germany) */
| 'NDS_DE'
+ /** Low German (Netherlands) */
| 'NDS_NL'
+ /** North Ndebele (Zimbabwe) */
| 'ND_ZW'
+ /** Nepali */
| 'NE'
+ /** Nepali (India) */
| 'NE_IN'
+ /** Nepali (Nepal) */
| 'NE_NP'
+ /** Dutch */
| 'NL'
+ /** Dutch (Aruba) */
| 'NL_AW'
+ /** Dutch (Belgium) */
| 'NL_BE'
+ /** Dutch (Caribbean Netherlands) */
| 'NL_BQ'
+ /** Dutch (Curaçao) */
| 'NL_CW'
+ /** Dutch (Netherlands) */
| 'NL_NL'
+ /** Dutch (Suriname) */
| 'NL_SR'
+ /** Dutch (Sint Maarten) */
| 'NL_SX'
+ /** Kwasio */
| 'NMG'
+ /** Kwasio (Cameroon) */
| 'NMG_CM'
+ /** Norwegian Nynorsk */
| 'NN'
+ /** Ngiemboon */
| 'NNH'
+ /** Ngiemboon (Cameroon) */
| 'NNH_CM'
+ /** Norwegian Nynorsk (Norway) */
| 'NN_NO'
+ /** Nuer */
| 'NUS'
+ /** Nuer (South Sudan) */
| 'NUS_SS'
+ /** Nyankole */
| 'NYN'
+ /** Nyankole (Uganda) */
| 'NYN_UG'
+ /** Oromo */
| 'OM'
+ /** Oromo (Ethiopia) */
| 'OM_ET'
+ /** Oromo (Kenya) */
| 'OM_KE'
+ /** Odia */
| 'OR'
+ /** Odia (India) */
| 'OR_IN'
+ /** Ossetic */
| 'OS'
+ /** Ossetic (Georgia) */
| 'OS_GE'
+ /** Ossetic (Russia) */
| 'OS_RU'
+ /** Punjabi */
| 'PA'
+ /** Punjabi (Arabic) */
| 'PA_ARAB'
+ /** Punjabi (Arabic, Pakistan) */
| 'PA_ARAB_PK'
+ /** Punjabi (Gurmukhi) */
| 'PA_GURU'
+ /** Punjabi (Gurmukhi, India) */
| 'PA_GURU_IN'
+ /** Nigerian Pidgin */
| 'PCM'
+ /** Nigerian Pidgin (Nigeria) */
| 'PCM_NG'
+ /** Polish */
| 'PL'
+ /** Polish (Poland) */
| 'PL_PL'
+ /** Prussian */
| 'PRG'
+ /** Pashto */
| 'PS'
+ /** Pashto (Afghanistan) */
| 'PS_AF'
+ /** Pashto (Pakistan) */
| 'PS_PK'
+ /** Portuguese */
| 'PT'
+ /** Portuguese (Angola) */
| 'PT_AO'
+ /** Portuguese (Brazil) */
| 'PT_BR'
+ /** Portuguese (Switzerland) */
| 'PT_CH'
+ /** Portuguese (Cape Verde) */
| 'PT_CV'
+ /** Portuguese (Equatorial Guinea) */
| 'PT_GQ'
+ /** Portuguese (Guinea-Bissau) */
| 'PT_GW'
+ /** Portuguese (Luxembourg) */
| 'PT_LU'
+ /** Portuguese (Macao SAR China) */
| 'PT_MO'
+ /** Portuguese (Mozambique) */
| 'PT_MZ'
+ /** Portuguese (Portugal) */
| 'PT_PT'
+ /** Portuguese (São Tomé & PrÃncipe) */
| 'PT_ST'
+ /** Portuguese (Timor-Leste) */
| 'PT_TL'
+ /** Quechua */
| 'QU'
+ /** Quechua (Bolivia) */
| 'QU_BO'
+ /** Quechua (Ecuador) */
| 'QU_EC'
+ /** Quechua (Peru) */
| 'QU_PE'
+ /** Romansh */
| 'RM'
+ /** Romansh (Switzerland) */
| 'RM_CH'
+ /** Rundi */
| 'RN'
+ /** Rundi (Burundi) */
| 'RN_BI'
+ /** Romanian */
| 'RO'
+ /** Rombo */
| 'ROF'
+ /** Rombo (Tanzania) */
| 'ROF_TZ'
+ /** Romanian (Moldova) */
| 'RO_MD'
+ /** Romanian (Romania) */
| 'RO_RO'
+ /** Russian */
| 'RU'
+ /** Russian (Belarus) */
| 'RU_BY'
+ /** Russian (Kyrgyzstan) */
| 'RU_KG'
+ /** Russian (Kazakhstan) */
| 'RU_KZ'
+ /** Russian (Moldova) */
| 'RU_MD'
+ /** Russian (Russia) */
| 'RU_RU'
+ /** Russian (Ukraine) */
| 'RU_UA'
+ /** Kinyarwanda */
| 'RW'
+ /** Rwa */
| 'RWK'
+ /** Rwa (Tanzania) */
| 'RWK_TZ'
+ /** Kinyarwanda (Rwanda) */
| 'RW_RW'
+ /** Sakha */
| 'SAH'
+ /** Sakha (Russia) */
| 'SAH_RU'
+ /** Samburu */
| 'SAQ'
+ /** Samburu (Kenya) */
| 'SAQ_KE'
+ /** Santali */
| 'SAT'
+ /** Santali (Ol Chiki) */
| 'SAT_OLCK'
+ /** Santali (Ol Chiki, India) */
| 'SAT_OLCK_IN'
+ /** Sangu */
| 'SBP'
+ /** Sangu (Tanzania) */
| 'SBP_TZ'
+ /** Sindhi */
| 'SD'
+ /** Sindhi (Arabic) */
| 'SD_ARAB'
+ /** Sindhi (Arabic, Pakistan) */
| 'SD_ARAB_PK'
+ /** Sindhi (Devanagari) */
| 'SD_DEVA'
+ /** Sindhi (Devanagari, India) */
| 'SD_DEVA_IN'
+ /** Northern Sami */
| 'SE'
+ /** Sena */
| 'SEH'
+ /** Sena (Mozambique) */
| 'SEH_MZ'
+ /** Koyraboro Senni */
| 'SES'
+ /** Koyraboro Senni (Mali) */
| 'SES_ML'
+ /** Northern Sami (Finland) */
| 'SE_FI'
+ /** Northern Sami (Norway) */
| 'SE_NO'
+ /** Northern Sami (Sweden) */
| 'SE_SE'
+ /** Sango */
| 'SG'
+ /** Sango (Central African Republic) */
| 'SG_CF'
+ /** Tachelhit */
| 'SHI'
+ /** Tachelhit (Latin) */
| 'SHI_LATN'
+ /** Tachelhit (Latin, Morocco) */
| 'SHI_LATN_MA'
+ /** Tachelhit (Tifinagh) */
| 'SHI_TFNG'
+ /** Tachelhit (Tifinagh, Morocco) */
| 'SHI_TFNG_MA'
+ /** Sinhala */
| 'SI'
+ /** Sinhala (Sri Lanka) */
| 'SI_LK'
+ /** Slovak */
| 'SK'
+ /** Slovak (Slovakia) */
| 'SK_SK'
+ /** Slovenian */
| 'SL'
+ /** Slovenian (Slovenia) */
| 'SL_SI'
+ /** Inari Sami */
| 'SMN'
+ /** Inari Sami (Finland) */
| 'SMN_FI'
+ /** Shona */
| 'SN'
+ /** Shona (Zimbabwe) */
| 'SN_ZW'
+ /** Somali */
| 'SO'
+ /** Somali (Djibouti) */
| 'SO_DJ'
+ /** Somali (Ethiopia) */
| 'SO_ET'
+ /** Somali (Kenya) */
| 'SO_KE'
+ /** Somali (Somalia) */
| 'SO_SO'
+ /** Albanian */
| 'SQ'
+ /** Albanian (Albania) */
| 'SQ_AL'
+ /** Albanian (North Macedonia) */
| 'SQ_MK'
+ /** Albanian (Kosovo) */
| 'SQ_XK'
+ /** Serbian */
| 'SR'
+ /** Serbian (Cyrillic) */
| 'SR_CYRL'
+ /** Serbian (Cyrillic, Bosnia & Herzegovina) */
| 'SR_CYRL_BA'
+ /** Serbian (Cyrillic, Montenegro) */
| 'SR_CYRL_ME'
+ /** Serbian (Cyrillic, Serbia) */
| 'SR_CYRL_RS'
+ /** Serbian (Cyrillic, Kosovo) */
| 'SR_CYRL_XK'
+ /** Serbian (Latin) */
| 'SR_LATN'
+ /** Serbian (Latin, Bosnia & Herzegovina) */
| 'SR_LATN_BA'
+ /** Serbian (Latin, Montenegro) */
| 'SR_LATN_ME'
+ /** Serbian (Latin, Serbia) */
| 'SR_LATN_RS'
+ /** Serbian (Latin, Kosovo) */
| 'SR_LATN_XK'
+ /** Sundanese */
| 'SU'
+ /** Sundanese (Latin) */
| 'SU_LATN'
+ /** Sundanese (Latin, Indonesia) */
| 'SU_LATN_ID'
+ /** Swedish */
| 'SV'
+ /** Swedish (Ã…land Islands) */
| 'SV_AX'
+ /** Swedish (Finland) */
| 'SV_FI'
+ /** Swedish (Sweden) */
| 'SV_SE'
+ /** Swahili */
| 'SW'
+ /** Swahili (Congo - Kinshasa) */
| 'SW_CD'
+ /** Swahili (Kenya) */
| 'SW_KE'
+ /** Swahili (Tanzania) */
| 'SW_TZ'
+ /** Swahili (Uganda) */
| 'SW_UG'
+ /** Tamil */
| 'TA'
+ /** Tamil (India) */
| 'TA_IN'
+ /** Tamil (Sri Lanka) */
| 'TA_LK'
+ /** Tamil (Malaysia) */
| 'TA_MY'
+ /** Tamil (Singapore) */
| 'TA_SG'
+ /** Telugu */
| 'TE'
+ /** Teso */
| 'TEO'
+ /** Teso (Kenya) */
| 'TEO_KE'
+ /** Teso (Uganda) */
| 'TEO_UG'
+ /** Telugu (India) */
| 'TE_IN'
+ /** Tajik */
| 'TG'
+ /** Tajik (Tajikistan) */
| 'TG_TJ'
+ /** Thai */
| 'TH'
+ /** Thai (Thailand) */
| 'TH_TH'
+ /** Tigrinya */
| 'TI'
+ /** Tigrinya (Eritrea) */
| 'TI_ER'
+ /** Tigrinya (Ethiopia) */
| 'TI_ET'
+ /** Turkmen */
| 'TK'
+ /** Turkmen (Turkmenistan) */
| 'TK_TM'
+ /** Tongan */
| 'TO'
+ /** Tongan (Tonga) */
| 'TO_TO'
+ /** Turkish */
| 'TR'
+ /** Turkish (Cyprus) */
| 'TR_CY'
+ /** Turkish (Turkey) */
| 'TR_TR'
+ /** Tatar */
| 'TT'
+ /** Tatar (Russia) */
| 'TT_RU'
+ /** Tasawaq */
| 'TWQ'
+ /** Tasawaq (Niger) */
| 'TWQ_NE'
+ /** Central Atlas Tamazight */
| 'TZM'
+ /** Central Atlas Tamazight (Morocco) */
| 'TZM_MA'
+ /** Uyghur */
| 'UG'
+ /** Uyghur (China) */
| 'UG_CN'
+ /** Ukrainian */
| 'UK'
+ /** Ukrainian (Ukraine) */
| 'UK_UA'
+ /** Urdu */
| 'UR'
+ /** Urdu (India) */
| 'UR_IN'
+ /** Urdu (Pakistan) */
| 'UR_PK'
+ /** Uzbek */
| 'UZ'
+ /** Uzbek (Arabic) */
| 'UZ_ARAB'
+ /** Uzbek (Arabic, Afghanistan) */
| 'UZ_ARAB_AF'
+ /** Uzbek (Cyrillic) */
| 'UZ_CYRL'
+ /** Uzbek (Cyrillic, Uzbekistan) */
| 'UZ_CYRL_UZ'
+ /** Uzbek (Latin) */
| 'UZ_LATN'
+ /** Uzbek (Latin, Uzbekistan) */
| 'UZ_LATN_UZ'
+ /** Vai */
| 'VAI'
+ /** Vai (Latin) */
| 'VAI_LATN'
+ /** Vai (Latin, Liberia) */
| 'VAI_LATN_LR'
+ /** Vai (Vai) */
| 'VAI_VAII'
+ /** Vai (Vai, Liberia) */
| 'VAI_VAII_LR'
+ /** Vietnamese */
| 'VI'
+ /** Vietnamese (Vietnam) */
| 'VI_VN'
+ /** Volapük */
| 'VO'
+ /** Vunjo */
| 'VUN'
+ /** Vunjo (Tanzania) */
| 'VUN_TZ'
+ /** Walser */
| 'WAE'
+ /** Walser (Switzerland) */
| 'WAE_CH'
+ /** Wolof */
| 'WO'
+ /** Wolof (Senegal) */
| 'WO_SN'
+ /** Xhosa */
| 'XH'
+ /** Xhosa (South Africa) */
| 'XH_ZA'
+ /** Soga */
| 'XOG'
+ /** Soga (Uganda) */
| 'XOG_UG'
+ /** Yangben */
| 'YAV'
+ /** Yangben (Cameroon) */
| 'YAV_CM'
+ /** Yiddish */
| 'YI'
+ /** Yoruba */
| 'YO'
+ /** Yoruba (Benin) */
| 'YO_BJ'
+ /** Yoruba (Nigeria) */
| 'YO_NG'
+ /** Cantonese */
| 'YUE'
+ /** Cantonese (Simplified) */
| 'YUE_HANS'
+ /** Cantonese (Simplified, China) */
| 'YUE_HANS_CN'
+ /** Cantonese (Traditional) */
| 'YUE_HANT'
+ /** Cantonese (Traditional, Hong Kong SAR China) */
| 'YUE_HANT_HK'
+ /** Standard Moroccan Tamazight */
| 'ZGH'
+ /** Standard Moroccan Tamazight (Morocco) */
| 'ZGH_MA'
+ /** Chinese */
| 'ZH'
+ /** Chinese (Simplified) */
| 'ZH_HANS'
+ /** Chinese (Simplified, China) */
| 'ZH_HANS_CN'
+ /** Chinese (Simplified, Hong Kong SAR China) */
| 'ZH_HANS_HK'
+ /** Chinese (Simplified, Macao SAR China) */
| 'ZH_HANS_MO'
+ /** Chinese (Simplified, Singapore) */
| 'ZH_HANS_SG'
+ /** Chinese (Traditional) */
| 'ZH_HANT'
+ /** Chinese (Traditional, Hong Kong SAR China) */
| 'ZH_HANT_HK'
+ /** Chinese (Traditional, Macao SAR China) */
| 'ZH_HANT_MO'
+ /** Chinese (Traditional, Taiwan) */
| 'ZH_HANT_TW'
+ /** Zulu */
| 'ZU'
+ /** Zulu (South Africa) */
| 'ZU_ZA';
export type LanguageDisplay = {
@@ -10143,6 +11200,8 @@ export type Margin = {
*
* PAYMENT_FLOW - new orders marked as paid will receive a
* `Payment` object, that will cover the `order.total`.
+ *
+ *
*/
export type MarkAsPaidStrategyEnum =
| 'PAYMENT_FLOW'
@@ -10848,6 +11907,7 @@ export type MetadataFilter = {
* Matches objects where the metadata key "color" is set to either "blue" or "green".
* - `{key: "status", value: {eq: "active"}}`
* Matches objects where the metadata key "status" is set to "active".
+ *
*/
export type MetadataFilterInput = {
/** Key to filter by. If not other fields provided - checking the existence of the key in metadata. */
@@ -11072,6 +12132,22 @@ export type Mutation = {
appFetchManifest: Maybe;
/** Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. */
appInstall: Maybe;
+ /**
+ * Add a problem to the calling app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: AUTHENTICATED_APP.
+ */
+ appProblemCreate: Maybe;
+ /**
+ * Dismiss problems for an app.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP.
+ */
+ appProblemDismiss: Maybe;
/**
* Re-enable sync webhooks for provided app. Can be used to manually re-enable sync webhooks for the app before the cooldown period ends.
*
@@ -11619,24 +12695,28 @@ export type Mutation = {
* 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.
+ * @deprecated Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.
*/
digitalContentCreate: Maybe;
/**
* Remove digital content assigned to given variant.
*
* Requires one of the following permissions: MANAGE_PRODUCTS.
+ * @deprecated Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.
*/
digitalContentDelete: Maybe;
/**
* Updates digital content.
*
* Requires one of the following permissions: MANAGE_PRODUCTS.
+ * @deprecated Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.
*/
digitalContentUpdate: Maybe;
/**
* Generate new URL to digital content.
*
* Requires one of the following permissions: MANAGE_PRODUCTS.
+ * @deprecated Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.
*/
digitalContentUrlCreate: Maybe;
/**
@@ -12709,6 +13789,22 @@ export type Mutation = {
* - STAFF_SET_PASSWORD_REQUESTED (async): Setting a new password for the staff account is requested.
*/
requestPasswordReset: Maybe;
+ /**
+ * Updates ReturnSettings. The `Page` (Model) Type will be cleared from `reasonReferenceType`. When it's cleared, passing reason reference to return mutations is no longer accepted and will raise error.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_SETTINGS.
+ */
+ returnReasonReferenceClear: Maybe;
+ /**
+ * Update return settings across all channels.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: MANAGE_SETTINGS.
+ */
+ returnSettingsUpdate: Maybe;
/**
* Deletes sales.
*
@@ -13049,7 +14145,7 @@ export type Mutation = {
transactionEventReport: Maybe;
/** Initializes a transaction session. It triggers the webhook `TRANSACTION_INITIALIZE_SESSION`, to the requested `paymentGateways`. There is a limit of 100 transaction items per checkout / order. */
transactionInitialize: Maybe;
- /** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */
+ /** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */
transactionProcess: Maybe;
/**
* Request an action for payment transaction.
@@ -13343,6 +14439,16 @@ export type MutationAppInstallArgs = {
};
+export type MutationAppProblemCreateArgs = {
+ input: AppProblemCreateInput;
+};
+
+
+export type MutationAppProblemDismissArgs = {
+ input: AppProblemDismissInput;
+};
+
+
export type MutationAppReenableSyncWebhooksArgs = {
appId: Scalars['ID'];
};
@@ -14724,6 +15830,11 @@ export type MutationRequestPasswordResetArgs = {
};
+export type MutationReturnSettingsUpdateArgs = {
+ input: ReturnSettingsUpdateInput;
+};
+
+
export type MutationSaleBulkDeleteArgs = {
ids: Array;
};
@@ -15482,7 +16593,11 @@ export type Order = Node & ObjectWithMetadata & {
* Requires one of the following permissions: MANAGE_ORDERS.
*/
totalRemainingGrant: Money;
- /** Google Analytics tracking client ID. */
+ /**
+ * Google Analytics tracking client ID.
+ *
+ * DEPRECATED: this field will be removed.
+ */
trackingClientId: Scalars['String'];
/** List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. */
transactions: Array;
@@ -15587,6 +16702,7 @@ export type OrderAddNoteInput = {
* `order.total`-`order.totalGrantedRefund`
* FULL - the funds that are authorized and charged fully cover the
* `order.total`-`order.totalGrantedRefund`
+ *
*/
export type OrderAuthorizeStatusEnum =
| 'FULL'
@@ -15990,6 +17106,7 @@ export type OrderCapture = {
* `order.total`-`order.totalGrantedRefund`
* OVERCHARGED - the charged funds are bigger than the
* `order.total`-`order.totalGrantedRefund`
+ *
*/
export type OrderChargeStatusEnum =
| 'FULL'
@@ -16409,7 +17526,7 @@ export type OrderEventsEmailsEnum =
| 'SHIPPING_CONFIRMATION'
| 'TRACKING_UPDATED';
-/** The different order event types. */
+/** The different order event types. */
export type OrderEventsEnum =
| 'ADDED_PRODUCTS'
| 'CANCELED'
@@ -16690,6 +17807,12 @@ export type OrderGrantRefundCreateLineInput = {
quantity: Scalars['Int'];
/** Reason of the granted refund for the line. */
reason: InputMaybe;
+ /**
+ * ID of a `Page` to reference as reason for this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: InputMaybe;
};
/**
@@ -16762,6 +17885,12 @@ export type OrderGrantRefundUpdateLineAddInput = {
quantity: Scalars['Int'];
/** Reason of the granted refund for the line. */
reason: InputMaybe;
+ /**
+ * ID of a `Page` to reference as reason for this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: InputMaybe;
};
export type OrderGrantRefundUpdateLineError = {
@@ -16841,6 +17970,12 @@ export type OrderGrantedRefundLine = {
quantity: Scalars['Int'];
/** Reason for refunding the line. */
reason: Maybe;
+ /**
+ * Reason Model (Page) reference for this refund line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: Maybe;
};
/**
@@ -16850,6 +17985,7 @@ export type OrderGrantedRefundLine = {
* PENDING - the refund on related transactionItem is pending
* FULL - the refund on related transactionItem is fully processed
* FAIL - the refund on related transactionItem failed
+ *
*/
export type OrderGrantedRefundStatusEnum =
| 'FAILURE'
@@ -16991,12 +18127,12 @@ export type OrderLinePrivateMetafieldsArgs = {
/** Represents order line of particular order. */
export type OrderLineThumbnailArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
export type OrderLineCreateInput = {
- /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
+ /** Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. */
forceNewLine: InputMaybe;
/** Custom price of the item.When the line with the same variant will be provided multiple times, the last price will be used. */
price: InputMaybe;
@@ -17299,6 +18435,18 @@ export type OrderReturnFulfillmentLineInput = {
fulfillmentLineId: Scalars['ID'];
/** The number of items to be returned. */
quantity: Scalars['Int'];
+ /**
+ * Reason for returning the line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason: InputMaybe;
+ /**
+ * ID of a `Page` to reference as reason for returning this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: InputMaybe;
/** Determines, if the line should be added to replace order. */
replace: InputMaybe;
};
@@ -17308,6 +18456,18 @@ export type OrderReturnLineInput = {
orderLineId: Scalars['ID'];
/** The number of items to be returned. */
quantity: Scalars['Int'];
+ /**
+ * Reason for returning the line.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason: InputMaybe;
+ /**
+ * ID of a `Page` to reference as reason for returning this line. When provided, must match the configured `PageType` in refund settings. Always optional for both staff and apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: InputMaybe;
/** Determines, if the line should be added to replace order. */
replace: InputMaybe;
};
@@ -17321,6 +18481,18 @@ export type OrderReturnProductsInput = {
includeShippingCosts: InputMaybe;
/** List of unfulfilled lines to return. */
orderLines: InputMaybe>;
+ /**
+ * Global reason for the return.
+ *
+ * Added in Saleor 3.22.
+ */
+ reason: InputMaybe;
+ /**
+ * ID of a `Page` to reference as reason for the return. Required for staff users when refund reason reference type is configured. Always optional for apps.
+ *
+ * Added in Saleor 3.22.
+ */
+ reasonReference: InputMaybe;
/** If true, Saleor will call refund action for all lines. */
refund: InputMaybe;
};
@@ -17917,7 +19089,8 @@ export type PageCreateInput = {
pageType: Scalars['ID'];
/**
* Publication date. ISO 8601 standard.
- * @deprecated Use `publishedAt` field instead.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
*/
publicationDate: InputMaybe;
/** Publication date time. ISO 8601 standard. */
@@ -18030,7 +19203,8 @@ export type PageInput = {
isPublished: InputMaybe;
/**
* Publication date. ISO 8601 standard.
- * @deprecated Use `publishedAt` field instead.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
*/
publicationDate: InputMaybe;
/** Publication date time. ISO 8601 standard. */
@@ -18872,13 +20046,14 @@ export type PaymentGatewayInitializeTokenizationErrorCode =
* SUCCESSFULLY_INITIALIZED - The payment gateway was successfully initialized.
* FAILED_TO_INITIALIZE - The payment gateway was not initialized.
* FAILED_TO_DELIVER - The request to initialize payment gateway was not delivered.
+ *
*/
export type PaymentGatewayInitializeTokenizationResult =
| 'FAILED_TO_DELIVER'
| 'FAILED_TO_INITIALIZE'
| 'SUCCESSFULLY_INITIALIZED';
-/** Event sent to initialize a new session in payment gateway to store the payment method. */
+/** Event sent to initialize a new session in payment gateway to store the payment method. */
export type PaymentGatewayInitializeTokenizationSession = Event & {
__typename: 'PaymentGatewayInitializeTokenizationSession';
/** Channel related to the requested action. */
@@ -19126,6 +20301,7 @@ export type PaymentMethodRequestDeleteError = {
* PENDING - The payment method is pending tokenization.
* FAILED_TO_TOKENIZE - The payment method was not tokenized.
* FAILED_TO_DELIVER - The request to tokenize payment method was not delivered.
+ *
*/
export type PaymentMethodTokenizationResult =
| 'ADDITIONAL_ACTION_REQUIRED'
@@ -19140,6 +20316,8 @@ export type PaymentMethodTokenizationResult =
* The following types are possible:
* CARD - represents a card payment method.
* OTHER - represents any payment method that is not a card payment.
+ *
+ *
*/
export type PaymentMethodTypeEnum =
| 'CARD'
@@ -19903,7 +21081,7 @@ export type ProductProductVariantsArgs = {
/** Represents an individual item for sale in the storefront. */
export type ProductThumbnailArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
@@ -20040,7 +21218,8 @@ export type ProductBulkCreateInput = {
channelListings: InputMaybe>;
/**
* Determine if taxes are being charged for the product.
- * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ *
+ * DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
*/
chargeTaxes: InputMaybe;
/** List of IDs of collections that the product belongs to. */
@@ -20081,7 +21260,8 @@ export type ProductBulkCreateInput = {
taxClass: InputMaybe;
/**
* Tax rate for enabled tax gateway.
- * @deprecated 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.
+ *
+ * DEPRECATED: this field will be removed. 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: InputMaybe;
/** Input list of product variants to create. */
@@ -20211,7 +21391,8 @@ export type ProductChannelListingAddInput = {
availableForPurchaseAt: InputMaybe;
/**
* 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 Use `availableForPurchaseAt` field instead.
+ *
+ * DEPRECATED: this field will be removed. Use `availableForPurchaseAt` field instead.
*/
availableForPurchaseDate: InputMaybe;
/** ID of a channel. */
@@ -20222,7 +21403,8 @@ export type ProductChannelListingAddInput = {
isPublished: InputMaybe;
/**
* Publication date. ISO 8601 standard.
- * @deprecated Use `publishedAt` field instead.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
*/
publicationDate: InputMaybe;
/** Publication date time. ISO 8601 standard. */
@@ -20324,7 +21506,8 @@ export type ProductCreateInput = {
category: InputMaybe;
/**
* Determine if taxes are being charged for the product.
- * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ *
+ * DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
*/
chargeTaxes: InputMaybe;
/** List of IDs of collections that the product belongs to. */
@@ -20363,7 +21546,8 @@ export type ProductCreateInput = {
taxClass: InputMaybe;
/**
* Tax rate for enabled tax gateway.
- * @deprecated 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.
+ *
+ * DEPRECATED: this field will be removed. 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: InputMaybe;
/** Weight of the Product. */
@@ -20452,6 +21636,7 @@ export type ProductErrorCode =
| 'DUPLICATED_INPUT_ITEM'
| 'GRAPHQL_ERROR'
| 'INVALID'
+ | 'INVALID_FILE_TYPE'
| 'INVALID_PRICE'
| 'MEDIA_ALREADY_ASSIGNED'
| 'NOT_FOUND'
@@ -20463,6 +21648,7 @@ export type ProductErrorCode =
| 'REQUIRED'
| 'UNIQUE'
| 'UNSUPPORTED_MEDIA_PROVIDER'
+ | 'UNSUPPORTED_MIME_TYPE'
| 'VARIANT_NO_DIGITAL_CONTENT';
/** Event sent when product export is completed. */
@@ -20501,7 +21687,8 @@ export type ProductFilterInput = {
categories: InputMaybe>;
/**
* Specifies the channel by which the data should be filtered.
- * @deprecated Use root-level channel argument instead.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
*/
channel: InputMaybe;
collections: InputMaybe>;
@@ -20547,7 +21734,7 @@ export type ProductImage = {
/** Represents a product image. */
export type ProductImageUrlArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
@@ -20558,7 +21745,8 @@ export type ProductInput = {
category: InputMaybe;
/**
* Determine if taxes are being charged for the product.
- * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
+ *
+ * DEPRECATED: this field will be removed. Use `Channel.taxConfiguration` to configure whether tax collection is enabled.
*/
chargeTaxes: InputMaybe;
/** List of IDs of collections that the product belongs to. */
@@ -20595,7 +21783,8 @@ export type ProductInput = {
taxClass: InputMaybe;
/**
* Tax rate for enabled tax gateway.
- * @deprecated 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.
+ *
+ * DEPRECATED: this field will be removed. 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: InputMaybe;
/** Weight of the Product. */
@@ -20668,7 +21857,7 @@ export type ProductMediaPrivateMetafieldsArgs = {
/** Represents a product media. */
export type ProductMediaUrlArgs = {
- format?: InputMaybe;
+ format: InputMaybe;
size: InputMaybe;
};
@@ -20838,7 +22027,8 @@ export type ProductOrder = {
attributeId: InputMaybe;
/**
* Specifies the channel in which to sort the data.
- * @deprecated Use root-level channel argument instead.
+ *
+ * DEPRECATED: this field will be removed. Use root-level channel argument instead.
*/
channel: InputMaybe;
/** Specifies the direction in which to sort products. */
@@ -21285,7 +22475,8 @@ export type ProductTypeInput = {
taxClass: InputMaybe;
/**
* Tax rate for enabled tax gateway.
- * @deprecated 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.
+ *
+ * DEPRECATED: this field will be removed. 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: InputMaybe;
/** List of attributes used to distinguish between different variants of a product. */
@@ -21596,7 +22787,11 @@ export type ProductVariantBulkCreate = {
/** Returns how many objects were created. */
count: Scalars['Int'];
errors: Array;
- /** List of the created variants. */
+ /**
+ * List of the created variants.
+ *
+ * DEPRECATED: this field will be removed.
+ */
productVariants: Array;
/** List of the created variants. */
results: Array;
@@ -23385,7 +24580,8 @@ export type PublishableChannelListingInput = {
isPublished: InputMaybe;
/**
* Publication date. ISO 8601 standard.
- * @deprecated Use `publishedAt` field instead.
+ *
+ * DEPRECATED: this field will be removed. Use `publishedAt` field instead.
*/
publicationDate: InputMaybe;
/** Publication date time. ISO 8601 standard. */
@@ -23482,12 +24678,14 @@ export type Query = {
* Look up digital content by ID.
*
* Requires one of the following permissions: MANAGE_PRODUCTS.
+ * @deprecated Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.
*/
digitalContent: Maybe;
/**
* List of digital content.
*
* Requires one of the following permissions: MANAGE_PRODUCTS.
+ * @deprecated Support for Digital Content is deprecated and will be removed in Saleor v3.23.0. This functionality is legacy and undocumented, and is not part of the supported API. Users should not rely on this behavior.
*/
digitalContents: Maybe;
/**
@@ -23659,6 +24857,8 @@ export type Query = {
* @deprecated Field no longer supported
*/
reportProductSales: Maybe;
+ /** Returns related settings. Returns `ReturnSettings` configuration, global for the entire shop. */
+ returnSettings: ReturnSettings;
/**
* Look up a sale by ID.
*
@@ -23735,7 +24935,11 @@ export type Query = {
* Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
*/
taxCountryConfiguration: Maybe;
- /** \n\nRequires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */
+ /**
+ *
+ *
+ * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP.
+ */
taxCountryConfigurations: Maybe>;
/**
* List of all tax rates available from tax gateway.
@@ -23745,9 +24949,17 @@ export type Query = {
/**
* Look up a transaction by ID.
*
- * Requires one of the following permissions: HANDLE_PAYMENTS.
+ * Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
*/
transaction: Maybe;
+ /**
+ * List of transactions. For apps with `MANAGE_ORDERS` permission, returns all transactions. For apps with just `HANDLE_PAYMENTS` permission, returns only transactions created by that app. For staff users, returns transactions from orders and checkouts in channels they have access to.
+ *
+ * Added in Saleor 3.22.
+ *
+ * Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS.
+ */
+ transactions: Maybe;
/**
* Lookup a translatable item by ID.
*
@@ -24354,6 +25566,15 @@ export type QueryTransactionArgs = {
};
+export type QueryTransactionsArgs = {
+ after: InputMaybe;
+ before: InputMaybe;
+ first: InputMaybe;
+ last: InputMaybe;
+ where: InputMaybe